Git Product home page Git Product logo

snakepipes's Introduction

snakePipes

Documentation Status

Build Staus

Citation

snakePipes are flexible and powerful workflows built using snakemake that simplify the analysis of NGS data.

Workflows available

  • DNA-mapping*
  • ChIP-seq*
  • RNA-seq*
  • ATAC-seq*
  • scRNA-seq
  • Hi-C
  • Whole Genome Bisulfite Seq/WGBS

(*Also available in "allele-specific" mode)

Installation

Snakepipes uses conda for installation and dependency resolution, so you will need to install conda first.

Afterward, simply run the following:

conda create -n snakePipes -c mpi-ie -c bioconda -c conda-forge snakePipes

This will create a new conda environment called "snakePipes" into which snakePipes is installed. You will then need to create the conda environments needed by the various workflows. To facilitate this we provide the snakePipes commands:

  • source activate snakePipes to activate the appropriate conda environment.
  • snakePipes createEnvs to create the various environments and register GATK.

Indicies and annotations needed to run the workflows could be created by a simple command :

createIndicies --genomeURL <path/url to your genome fasta> --gtfURL <path/url to genes.gtf> -o <output_dir> <name>

where name refers to the name/id of your genome (specify as you wish).

A few additional steps you can then take:

1. Modify/remove/add the organism yaml files appropriately : these yaml files would contain location of appropriate GTF files and genome indexes corresponding to different organisms. The location of these files after installation can be found using snakePipes --info command.

2. Modify the cluster.yaml file appropriately : This yaml file contains settings for your cluster scheduler (SGE/slurm). Location revealed using snakePipes --info command.

Documentation

For detailed documentation on setup and usage, please visit our read the docs page.

Citation

If you adopt/run snakePipes for your analysis, cite it as follows :

Bhardwaj V, Heyne S, Sikora K, Rabbani L, Rauer M, Kilpert F, et al. snakePipes enable flexible, scalable and integrative epigenomic analysis. bioRxiv. 2018. p. 407312. doi:10.1101/407312

Note

SnakePipes are under active development. We appreciate your help in improving it further. Please use issues to the GitHub repository for feature requests or bug reports.

snakepipes's People

Contributors

asrichter avatar dpryan79 avatar gtrichard avatar hilgersv avatar jaboehm avatar katsikora avatar kilpert avatar leilyr avatar mirax87 avatar steffenheyne avatar vivekbhr avatar

Watchers

 avatar

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.