Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.62 KB

README.md

File metadata and controls

56 lines (36 loc) · 2.62 KB

linux osx pytest readthedocs citation

SnakePipes

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

Workflows

  • DNAmapping*
  • ChIPseq*
  • mRNAseq*
  • ncRNAseq*
  • ATACseq*
  • scRNAseq
  • HiC
  • makePairs*
  • Whole Genome Bisulfite Seq/WGBS

(* also available in allele-specific mode)

Installation

Conda is a pre-requisite for snakePipes. So make sure this is installed before.

Afterwards you can create a snakePipes environment containing the installation by running:

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

In case you'd like a development version, you can install snakePipes directly from github using pip:

git clone [email protected]:maxplanck-ie/snakepipes.git
cd snakepipes pip install .

Make sure the environment you are installing this version into has python version 3.11 or later.

After the installation some configurations have to be set, for which we refer to the documentation.

Documentation

For detailed documentation on setup and usage, please visit the documentation.

Citation

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

Bhardwaj, Vivek, Steffen Heyne, Katarzyna Sikora, Leily Rabbani, Michael Rauer, Fabian Kilpert, Andreas S. Richter, Devon P. Ryan, and Thomas Manke. 2019. “snakePipes: Facilitating Flexible, Scalable and Integrative Epigenomic Analysis.” Bioinformatics , May. doi:10.1093/bioinformatics/btz436.

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.