nf-core/methylong

Edit

Introduction

nf-core/methylong is a bioinformatics pipeline that processes modification basecalled ONT reads or PacBio HiFi reads (modBam) by performing preprocessing steps (including trimming and tag repair), aligning them to the provided genome assembly, and extracting methylation calls into BED/BEDGraph format, ready for direct downstream analysis.

ONT workflow:

1. trim and repair tags of input modBam

   • trim and repair workflow:
     1. sort modBam - samtools sort
     2. convert modBam to fastq - samtools fastq
     3. trim barcode and adapters - porechop
     4. convert trimmed modfastq to modBam - samtools import
     5. repair MM/ML tags of trimmed modBam - modkit repair

2. align to reference (plus sorting and indexing) - dorado aligner

   • include alignment summary - samtools flagstat

3. create bedMethyl - modkit pileup

4. create bedgraphs (optional)

PacBio workflow:

1. align to reference - pbmm2 (default) or minimap2

   • minimap workflow:

     1. convert modBam to fastq - samtools convert
     2. alignment - minimap2
     3. sort and index - samtools sort
     4. alignment summary - samtools flagstat

   • pbmm2 workflow:

     1. alignment and sorting - pbmm2
     2. index - samtools index
     3. alignment summary - samtools flagstat

2. create bedMethyl - pb-CpG-tools (default) or modkit pileup

   • 2 pile up methods available from pb-CpG-tools:
     1. default using model
     2. or count (differences described here: https://github.com/PacificBiosciences/pb-CpG-tools)

3. create bedgraph (optional)

Usage

First, prepare a samplesheet with your input data that looks as follows:

samplesheet.csv:

sample,modbam,ref,method
Col_0,ont_modbam.bam,Col_0.fasta,ont

Now, you can run the pipeline using:

nextflow run nf-core/methylong \
   -profile <docker/singularity/.../institute> \
   --input samplesheet.csv \
   --outdir <OUTDIR>

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Parameters

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Folder stuctures of the outputs:

 
├── ont/sampleName
│   │
│   ├── trim
│   │   ├── trimmed.fastq.gz
│   │   ├── trimmed.bam
│   │   └── trimmed.log
│   │
│   ├── repair
│   │   ├── repaired.bam
│   │   └── repaired.log
│   │
│   ├── alignment
│   │   ├── aligned.bam
│   │   ├── aligned.bai
│   │   ├── summary.txt
│   │   └── aligned.flagstat
│   │
│   ├── pileup/modkit
│   │   ├── pileup.bed
│   │   └── pileup.log
│   │
│   └── bedgraph
│       └── bedgraphs
│ 
│  
└── pacbio/sampleName
    │
    ├── aligned_minimap2/ aligned_pbmm2
    │   ├── aligned.bam
    │   ├── aligned.bai/csi
    │   └── aligned.flagstat
    │
    ├── pileup: modkit/pb_cpg_tools
    │   ├── pileup.bed
    │   ├── pileup.log
    │   └── pileup.bw (only pb_cpg_tools)
    │
    └── bedgraph
        └── bedgraphs
 

Credits

nf-core/methylong was originally written by Jin Yan Khoo.

We thank the following people for their extensive assistance in the development of this pipeline:

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 the Slack #methylong channel (you can join with this invite).

Citations

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

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.