A metagenomic analysis pipeline for eukaryotic viruses written in nextflow.
Introduction
Viralgenie is a bioinformatics best-practice analysis pipeline for reconstructing consensus genomes and to identify intra-host variants from metagenomic sequencing data or enriched based sequencing data like hybrid capture.
Pipeline summary
- Read QC (
FastQC
) - Performs optional read pre-processing
- Adapter trimming(
fastp
,Trimmomatic
) - Read UMI deduplication (
HUMID
) - Low complexity and quality filtering (
bbduk
) - Host-read removal (
BowTie2
)
- Adapter trimming(
- Metagenomic diveristy mapping
- Denovo assembly (
SPAdes
,TRINITY
,megahit
), combine contigs. - Contig reference idententification (
blastn
)- Identify top 5 blast hits
- Merge blast hit and all contigs of a sample
- [Optional] Precluster contigs based on taxonomy
- Cluster contigs (or every taxonomic bin) of samples, options are:
- Scaffolding of contigs to centroid (
Minimap2
,iVar-consensus
) - [Optional] Annotate 0-depth regions with external reference
bin/lowcov_to_reference.py
. - [Optional] Select best reference from
--mapping_constrains
: - Mapping filtered reads to supercontig and mapping constrains(
BowTie2
,BWAmem2
andBWA
) - [Optional] Deduplicate reads (
Picard
or if UMI's are usedUMI-tools
) - Variant calling and filtering (
BCFTools
,iVar
) - Create consensus genome (
BCFTools
,iVar
) - Repeat step 11-14 multiple times for the denovo contig route
- Consensus evaluation and annotation (
QUAST
,CheckV
,blastn
,mmseqs-search
) - Result summary visualisation for raw read, alignment, assembly, variant calling and consensus calling results (
MultiQC
)
Usage
Note
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.
Now, you can run the pipeline using:
nextflow run Joon-Klaps/viralgenie \
-profile <docker/singularity/.../institute> \
--input samplesheet.csv \
--outdir <OUTDIR>
Warning
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.
Credits
Viralgenie was originally written by Joon-Klaps
.
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.
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.