Code Monkey home page Code Monkey logo

datasuper's Introduction

DataSuper

CircleCI master

Latest PyPI version CodeFactor

PyPI - Python version

PyPI - Downloads

Github license

Easy to use pipelines for large biological datasets.

Goals

Bioinformatics pipelines often involve a large number of files with complex organization and metadata. Often researchers keep these files organized with carefully patterned filenames, elaborate directory structures and spreadsheets containing metadata.

DataSuper builds on this approach. DataSuper provides a system to track files that groups files into related modules (i.e. the two fastq files usually used to represent forward and reverse reads), groups sets of modules with samples that store metadata, and groups sets of samples into projects. All of this information is stored in a simple yet customizable database with an API for programmatic access.

DataSuper is probably overkill for small projects, it has been designed in particular for the MetaSUB project which has thousands of samples and complex analysis pipelines. DataSuper makes it easier to keep track of the huge number of files associated with the analysis of these samples, in particular it helps as a bottom layer that can be accessed by higher level applications.

MetaSUB is also developing a program called ModuleUltra which builds off DataSuper and SnakeMake to provide easily distributable versioned pipelines.

In summary:
  • DataSuper works without disrupting existing bioinformatic workflows
  • DataSuper tightly packages data with metadata
  • DataSuper groups files in the same project
  • DataSuper packages data that is stored across multiple files
  • DataSuper allows programmatic access and ad-hoc grouping of files

Eventually DataSuper will support peer-to-peer sharing so that data can be more easily shared across academic sites.

Installation

Be aware that DataSuper is still an Alpha. There are likely many bugs, fotunately there is no risk that DataSuper will delete your files since it only exists as a layer on top of your systems filesystem.

DataSuper is currently being used on Ubuntu and RHEL systems. It should work on any *nix system.

To install:

git clone <url>

python setup.py develop

Licence

MIT License

Authors

DataSuper was written by David C. Danko.

datasuper's People

Contributors

bchrobot avatar dcdanko avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

longtailbio

datasuper's Issues

DataSuper cannot elegantly handle schema changes

Schema changes (particularly subtractions) can occur when pipelines change. Currently datasuper has no way to handle these changes if instantiated schema already exist.

Arguably DataSuper should not know what to do here because a changed schema could indicate that existing results with the old schema. The best way to handle this is probably to explicitly version schema and allow manual migration.

7e5ddcc

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.