nf-core/metatdenovo
Assembly and annotation of metatranscriptomic or metagenomic data for prokaryotic, eukaryotic and viruses.
Introduction
nf-core/metatdenovo is a bioinformatics best-practice analysis pipeline for assembly and annotation of metatranscriptomic data, both prokaryotic and eukaryotic.
The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources. The results obtained from the full-sized test can be viewed on the nf-core website.
Pipeline summary
- Read QC (
FastQC
) - Present QC for raw reads (
MultiQC
) - Quality trimming and adapter removal for raw reads (
Trim Galore!
) - Optional: Filter sequences with
BBduk
- Optional: Normalize the sequencing depth with
BBnorm
- Merge trimmed, pair-end reads (
Seqtk
) - Choice of de novo assembly programs:
- Choice of orf caller:
TransDecoder
suggested for EukaryotesProkka
suggested for ProkaryotesProdigal
suggested for Prokaryotes
- Quantification of genes identified in assemblies:
- Generate index of assembly (
BBmap index
) - Mapping cleaned reads to the assembly for quantification (
BBmap
) - Get raw counts per each gene present in the assembly (
Featurecounts
) -> TSV table with collected featurecounts output
- Generate index of assembly (
- Functional annotation:
Eggnog
-> Reformat TSV output “eggnog table”KOfamscan
HMMERsearch
-> Ranking orfs based on HMMprofile withHmmrank
- Taxonomic annotation:
- Summary statistics table. “Collect_stats.R”
Usage
If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test
before running the workflow on actual data.
First, prepare a samplesheet with your input data that looks as follows:
samplesheet.csv
:
Each row represents a fastq file (single-end) or a pair of fastq files (paired-end).
Now, you can run the pipeline using:
Please provide pipeline parameters via the CLI or Nextflow -params-file
option. Custom config files including those provided by the -c
Nextflow option can be used to provide any configuration except for parameters;
see docs.
For more details and further functionality, please refer to the usage documentation and the parameter documentation.
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.
Tables in summary_tables
directory under the output directory are made especially for further analysis in tools like R or Python.
Credits
nf-core/metatdenovo was originally written by Danilo Di Leo (@danilodileo), Emelie Nilsson (@emnilsson) & Daniel Lundin (@erikrikarddaniel).
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 #metatdenovo
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.