/methylseq

Methylation (Bisulfite-Sequencing) analysis pipeline using Bismark or bwa-meth + MethylDackel

Primary LanguageNextflowMIT LicenseMIT

nf-core/methylseq

DOI GitHub Actions CI Status GitHub Actions Linting Status Nextflow

install with bioconda Docker Container available

nf-core/methylseq is a bioinformatics analysis pipeline used for Methylation (Bisulfite) sequencing data. It pre-processes raw data from FastQ inputs, aligns the reads and performs extensive quality-control on the results.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible.

The pipeline allows you to choose between running either Bismark or bwa-meth / MethylDackel. Choose between workflows by using --aligner bismark (default, uses bowtie2 for alignment), --aligner bismark_hisat or --aligner bwameth.

Step Bismark workflow bwa-meth workflow
Generate Reference Genome Index (optional) Bismark bwa-meth
Raw data QC FastQC FastQC
Adapter sequence trimming Trim Galore! Trim Galore!
Align Reads Bismark bwa-meth
Deduplicate Alignments Bismark Picard MarkDuplicates
Extract methylation calls Bismark MethylDackel
Sample report Bismark -
Summary Report Bismark -
Alignment QC Qualimap Qualimap
Sample complexity Preseq Preseq
Project Report MultiQC MultiQC

Quick Start

i. Install nextflow

ii. Install either Docker or Singularity for full pipeline reproducibility (please only use Conda as a last resort; see docs)

iii. Download the pipeline and test it on a minimal dataset with a single command

nextflow run nf-core/methylseq -profile test,<docker/singularity/conda/institute>

Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile <institute> in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.

iv. Start running your own analysis!

nextflow run nf-core/methylseq -profile <docker/singularity/conda/institute> --reads '*_R{1,2}.fastq.gz' --genome GRCh37

See usage docs for all of the available options when running the pipeline.

Documentation

The nf-core/methylseq pipeline comes with documentation about the pipeline, found in the docs/ directory:

  1. Installation
  2. Pipeline configuration
  3. Running the pipeline
  4. Output and how to interpret the results
  5. Troubleshooting

Credits

These scripts were originally written for use at the National Genomics Infrastructure at SciLifeLab in Stockholm, Sweden.

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on Slack (you can join with this invite).

Citation

If you use nf-core/methylseq for your analysis, please cite it using the following doi: 10.5281/zenodo.2555454

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x. ReadCube: Full Access Link