nf-rsvpipeline

Viral RSV analysis pipeline using Illumina or Oxford Nanopore Technologies amplicon-based sequencing data

https://github.com/genomicsiter/nf-rsvpipeline

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: medrxiv.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Viral RSV analysis pipeline using Illumina or Oxford Nanopore Technologies amplicon-based sequencing data

Basic Info
  • Host: GitHub
  • Owner: genomicsITER
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Size: 2.82 MB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

nf-rsvpipeline

Nextflow nf-core

run with conda run with docker run with singularity

Follow on X

A public repository of Respiratory Syncytial Virus (RSV) genomic surveillance bioinformatic pipeline maintained by ITER.

Introduction

nf-rsvpipeline automates the processing of Illumina and Oxford Nanopore Technologies (ONT) amplicon-based sequencing datasets for viral genome analysis. It integrates multiple tools for quality control, taxonomic classification, reference selection, alignment, consensus generation, and variant calling.

The nf-rsvpipeline is built using Nextflow, following nf-core guidelines and templates.

Respiratory Syncytial Virus genomic surveillance in the Canary Islands

This pipeline is designed for the analysis of RSV whole genomes using short- and long-read sequencing technologies. It is developed as part of the research efforts documented in the following repository:

RSV Repository (genomicsITER/RSV)

The RSV repository contains genomic data, analysis scripts, and additional resources related to the study of Respiratory Syncytial Virus (RSV) cases detected in the Canary Islands between 2022 and 2024. The pipeline in this repository facilitates the automated processing and variant analysis of RSV sequencing datasets.

Illumina pipeline summary

Illumina pipeline

  1. Quality control of raw reads (FastQC)
  2. Taxonomic classification of raw reads (Kraken2)
  3. Adapter trimming (fastp)
  4. Quality control of trimmed reads (FastQC)
  5. Remove host reads (Kraken2)
  6. Multi-reference alignment to select reference (BBMap)
    1. Run alternative assembly strategy if previous MSA step failed (SPAdes)
  7. Align reads to the correct reference strain (BWA)
  8. Trim adapters before create consensus sequences (iVar)
  9. Coverage analysis (MosDepth)
  10. Create consensus sequence (iVar)
  11. Variant-calling (iVar)

ONT pipeline summary

ONT pipeline

  1. Quality control of raw reads (NanoPlot)
  2. Taxonomic classification of raw reads (Kraken2)
  3. Remove host reads (Kraken2)
  4. Quality control of dehosted reads (NanoPlot)
  5. Select reference to downstream analysis (IRMA)
  6. Align reads to the correct reference strain (Minimap2)
  7. Trim adapters before create consensus sequences (ARTIC)
  8. Coverage analysis (MosDepth)
  9. Create consensus sequence (Medaka)
  10. Variant-calling (Medaka)

Quick start

[!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.

  1. Install Nextflow (>=24.04.2) before running the pipeline.

  2. Make sure to download and set up the Kraken2 PlusPF and the Kraken2 HumanDB databases from this repository. Ensure that the database path is correctly set in the nextflow.config file using the kraken2_pluspf_database and kraken2_human_database parameters.

  3. Clone the repository:

bash git clone https://github.com/genomicsITER/nf-rsvpipeline cd nf-rsvpipeline

  1. Input Data Requirements: To run the pipeline, the user must provide sequencing data in the following format:
  • For Illumina data: A folder containing paired-end FASTQ files (_R1.fastq.gz and _R2.fastq.gz for each sample).
  • For ONT data: A folder containing single-end FASTQ files (.fastq.gz).
  1. Run the pipeline:

For Illumina paired-end datasets run the pipeline as follows:

bash nextflow run main.nf \ --indir /path/to/fastq_dir/illumina \ --outdir results_illumina \ --platform "illumina" \ -profile <docker/singularity/conda> \ -resume

For ONT datasets run the pipeline as follows:

bash nextflow run main.nf \ --indir /path/to/fastq_dir/nanopore \ --outdir results_nanopore \ --platform "nanopore" \ -profile <docker/singularity/conda> \ -resume

Additionaly, if you want to run pycoQC, you need to add the --sequencing_summary parameter:

bash nextflow run main.nf \ --indir /path/to/nanopore/fastq/files \ --outdir results_nanopore \ --platform "nanopore" \ --sequencing_summary sequencing_summary.txt \ -profile <docker/singularity/conda> \ -resume

For further assistance, feel free to open an issue in this repository.

How to cite this work

This work has not been publised yet.

Please cite this repository as: "nf-rsvpipeline (accessed on YYYY-MM-DD)". And do not forget to cite the paper when it becomes available. It is already available as a preprint at medRxiv:

  • A bench-to-data analysis workflow for respiratory syncytial virus whole-genome sequencing with short and long-read approaches. Adrian Gomez-Del Rosario, Adrian Munoz-Barrera, Julia Alcoba-Florez, Diego Garcia-Martinez de Artola, Nora Rodriguez-Garcia, Jose M. Lorenzo-Salazar, Rafaela Gonzalez-Montelongo, Carlos Flores, Laura Ciuffreda. doi: https://doi.org/10.1101/2025.04.07.25325192.

Funding

Cabildo Insular de Tenerife [CGIEU0000219140, CGIAC0000014697 and “Apuestas científicas del ITER para colaborar en la lucha contra la COVID-19”]; by the agreements OA17/008 and OA23/043 with Instituto Tecnológico y de Energías Renovables (ITER) to strengthen scientific and technological education, training, research, development and innovation in Genomics, Epidemiological surveillance based on sequencing, Personalized Medicine and Biotechnology; Fundación Canaria Instituto de Investigación Sanitaria de Canarias [PIFIISC21/37, EMER24/06 and “PROGRAMA INVESTIGO 2023, en el marco del plan de Recuperación, Transformación y Resiliencia – NEXT GENERATION EU”]; Fundación DISA [OA23/074]; Instituto de Salud Carlos III [PI20/00876, CD22/00138, CB06/06/1088], co-funded by the European Regional Development Fund, “A way of making Europe”; from the EU; European Health and Digital Executive Agency [HADEA, 101113109 -RELECOV 2.0]; and by Cabildo Insular de Tenerife and Consejería de Educación, Gobierno de Canarias [A0000014697].

Update logs

April 10, 2025. The preprint is alive at medRxiv. Enjoy the reading! ;=)

April 03, 2025. This repository became fully public.

February 27, 2025. Illumina and ONT pipelines (v1.0.0).

January 30, 2025. First commit.

Owner

  • Name: Genomics Division, ITER
  • Login: genomicsITER
  • Kind: user
  • Location: Tenerife, Canary Islands, SPAIN
  • Company: ITER

The area of Genomics of the Institute of Technology and Renewable Energy (ITER), at Tenerife, Canary Islands, SPAIN.

Citation (CITATIONS.md)

# nf-core/rsvpipeline: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

> Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)

> Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241.

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)

  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Watch event: 2
  • Push event: 32
  • Fork event: 1
Last Year
  • Watch event: 2
  • Push event: 32
  • Fork event: 1

Dependencies

.github/workflows/awsfulltest.yml actions
  • actions/upload-artifact v4 composite
  • octokit/request-action v2.x composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/awstest.yml actions
  • actions/upload-artifact v4 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
.github/workflows/ci.yml actions
  • actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
  • conda-incubator/setup-miniconda a4260408e20b96e80095f42ff7f1a15b27dd94ca composite
  • eWaterCycle/setup-apptainer main composite
  • jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
  • nf-core/setup-nextflow v2 composite
.github/workflows/clean-up.yml actions
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
.github/workflows/download_pipeline.yml actions
  • actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
  • eWaterCycle/setup-apptainer 4bb22c52d4f63406c49e94c804632975787312b3 composite
  • jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
  • nf-core/setup-nextflow v2 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
  • actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
  • peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
.github/workflows/linting.yml actions
  • actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
  • actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
  • actions/upload-artifact b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 composite
  • nf-core/setup-nextflow v2 composite
  • pietrobolcato/action-read-yaml 1.1.0 composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact 20319c5641d495c8a52e688b7dc5fada6c3a9fbc composite
  • marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
.github/workflows/release-announcements.yml actions
  • rzr/fediverse-action master composite
  • zentered/bluesky-post-action 80dbe0a7697de18c15ad22f4619919ceb5ccf597 composite
.github/workflows/template_version_comment.yml actions
  • actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
  • mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
  • nichmor/minimal-read-yaml v0.0.2 composite
modules/nf-core/bbmap/align/meta.yml cpan
modules/nf-core/blast/blastn/meta.yml cpan
modules/nf-core/bwa/index/meta.yml cpan
modules/nf-core/bwa/mem/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/ivar/consensus/meta.yml cpan
modules/nf-core/ivar/trim/meta.yml cpan
modules/nf-core/ivar/variants/meta.yml cpan
modules/nf-core/kraken2/kraken2/meta.yml cpan
modules/nf-core/minimap2/align/meta.yml cpan
modules/nf-core/mosdepth/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/nanoplot/meta.yml cpan
modules/nf-core/pycoqc/meta.yml cpan
modules/nf-core/samtools/depth/meta.yml cpan
modules/nf-core/samtools/flagstat/meta.yml cpan
modules/nf-core/samtools/idxstats/meta.yml cpan
modules/nf-core/samtools/index/meta.yml cpan
modules/nf-core/samtools/sort/meta.yml cpan
modules/nf-core/samtools/view/meta.yml cpan
modules/nf-core/spades/meta.yml cpan
subworkflows/nf-core/utils_nextflow_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfcore_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfschema_plugin/meta.yml cpan
modules/nf-core/bbmap/align/environment.yml pypi
modules/nf-core/blast/blastn/environment.yml pypi
modules/nf-core/bwa/index/environment.yml pypi
modules/nf-core/bwa/mem/environment.yml pypi
modules/nf-core/fastp/environment.yml pypi
modules/nf-core/fastqc/environment.yml pypi
modules/nf-core/ivar/consensus/environment.yml pypi
modules/nf-core/ivar/trim/environment.yml pypi
modules/nf-core/ivar/variants/environment.yml pypi
modules/nf-core/kraken2/kraken2/environment.yml pypi
modules/nf-core/minimap2/align/environment.yml pypi
modules/nf-core/mosdepth/environment.yml pypi
modules/nf-core/multiqc/environment.yml pypi
modules/nf-core/nanoplot/environment.yml pypi
modules/nf-core/pycoqc/environment.yml pypi
modules/nf-core/samtools/depth/environment.yml pypi
modules/nf-core/samtools/flagstat/environment.yml pypi
modules/nf-core/samtools/idxstats/environment.yml pypi
modules/nf-core/samtools/index/environment.yml pypi
modules/nf-core/samtools/sort/environment.yml pypi
modules/nf-core/samtools/view/environment.yml pypi
modules/nf-core/spades/environment.yml pypi