Skip to content
CDCgovPublic

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cdcgov/mva

MVA is a Nextflow pipeline for generating and reviewing high-quality viral genome assemblies from Illumina, Nanopore, and PacBio sequencing data. It currently routes supported targets through the IRMA iterative refinement meta-assembler. Illumina workflows are currently the recommended paths. The pipeline publishes assemblies, read and assembly QC, and a MultiQC report with miniQC genome-representation and coverage summaries.

Laboratories must validate the selected workflow, preset, and acceptance criteria within their own quality system before operational use.

Requirements

  • Git
  • Java compatible with the installed Nextflow release
  • Nextflow v25+
  • One container runtime: Docker (recommended for local machines) or Singularity/Apptainer (common in HPC environments)
  • Local storage for FASTQs, container images, the Nextflow work directory, and results

Check the local setup:

git --version
java -version
nextflow -version
docker info

If Docker is not available but you're on an HPC system, check for Singularity or Apptainer instead:

singularity --version
# or
apptainer --version

Important Note about Nextflow 26

If you are using Nextflow 26+, for the current MVA release (v2.4.0) , you will need to set NXF_SYNTAX_PARSER=v1 in the environment. This is in the examples below for sanity, but it is not nexessary in Nextflow 25.

Prepare a release

Use a tagged checkout so the pipeline and bundled parameter files remain matched:

git clone --branch v2.4.0 --depth 1 https://github.com/cdcgov/mva.git "$HOME/mva-v2.4.0"
cd "$HOME/mva-v2.4.0"

Samplesheet

Provide a CSV with one row per sample. sample and fastq_1 are required; add fastq_2 for paired-end reads.

sample,fastq_1,fastq_2
RUN01_SAMPLE_001,/absolute/path/RUN01_SAMPLE_001_R1.fastq.gz,/absolute/path/RUN01_SAMPLE_001_R2.fastq.gz

Use absolute paths, unique sample names without spaces, and FASTQ filenames ending in .fastq.gz or .fq.gz.

Quick starts

Run from the tagged checkout. Choose one validated preset and keep assay settings in that file; set only run-specific input, output, profile, and resume options on the command line.

Container runtime: Replace -profile docker with -profile singularity or -profile apptainer if Docker is unavailable. Docker is recommended for local machines; Singularity or Apptainer is typical in HPC environments.

Test with in silico data

Before running production data, validate your setup with the provided test samplesheet. (A template is also included at test-samplesheet.csv where you can update the FASTQ paths to point to a small in silico read dataset.) From the checkout directory, copy and run:

cd $HOME/mva-v2.4.0
export NXF_SYNTAX_PARSER=v1
nextflow run . \
    -params-file assets/presets/ilmn-multi-ml-v1.yml
    -profile singularity,test
    --outdir testing/test_profile

This runs the test profile, which pulls the test samplesheet and data, confirms the workflow, container runtime, and output handling work correctly before processing production samples.

Molecular Loop multipathogen

export NXF_SYNTAX_PARSER=v1
nextflow run . \
    -params-file assets/presets/ilmn-multi-ml-v1.yml \
    -profile docker \
    --input /absolute/path/multipathogen-samplesheet.csv \
    --outdir /absolute/path/results/RUN01_multipathogen \
    -resume

See the Molecular Loop guide for the supported targets, review guidance, and operational caveats.

Single-virus overlapping amplicons

SARS-CoV-2 ARTIC v5.3.2 is one bundled example:

export NXF_SYNTAX_PARSER=v1
nextflow run main.nf \
    -params-file assets/presets/ilmn-sc2-artic-v5.3.2.yml \
    -profile docker \
    --input /absolute/path/artic-samplesheet.csv \
    --outdir /absolute/path/results/RUN01_artic \
    -resume

See the single-virus overlapping-amplicon guide to select another organism-specific assay preset and review the primer file requirements and validation guidance.

Results

Relative to --outdir, review these primary outputs:

  • multiqc/: consolidated read, trimming, miniQC, and available pipeline QC report.
  • IRMA/: per-sample assembly outputs, consensus FASTAs, coverage, and minor-allele tables.
  • fastqc/: raw-read quality reports.
  • Amplicov/: amplicon coverage reports when the selected preset includes a primer BEDPE file.
  • pipeline_info/: parameters, validated samplesheet, software versions, and Nextflow execution reports.

The miniQC status is based only on canonical-genome representation. Interpret it alongside coverage, read context, controls, and the laboratory's validated review criteria.

Documentation

CDC institutional operations and LIMS adapters are maintained separately from this public pipeline.

Credits

MVA was originally written by CDC CORVD Bioinformatics and uses infrastructure developed by the nf-core community.

Public repository and releases

The public repository cdcgo/mva contains public release snapshots of MVA. Active development curently takes place in a separate internal repository, so the public commit history does not include individual development commits.

The main branch contains the latest published release snapshot. Each public release is also available under its version tag. For reproducible work, use a specific version tag rather than relying on main, which changes with each release.

Issues and contributions are welcome. See CONTRIBUTING.md.

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

This project is made available under the CC0 1.0 Universal public domain dedication.

Third-party dependencies and any separately identified third-party materials are subject to their own license terms.

Privacy Standard Notice

This public repository is intended for non-sensitive, publicly available information. Do not submit sensitive information, including personally identifiable information (PII), protected health information (PHI), credentials, or other non-public data, in code, issues, pull requests, or other repository communications.

For more information, see the CDC Privacy Policy.

Contributing Standard Notice

Contributions are welcome. Please read CONTRIBUTING.md and the Code of Conduct before contributing.

By submitting a contribution, you agree to dedicate your contribution under CC0 1.0 Universal and confirm that you have the authority to do so.

Comments, messages, pull requests, and other submissions may be subject to applicable federal law, including the Federal Records Act, and may be archived.

Records Management Standard Notice

This repository is not a source of government records; it is a copy provided to support collaboration. Government records will be published through the CDC website.

Additional Standard Notices

See DISCLAIMER.md for the project disclaimer and the Code of Conduct for community participation guidelines.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

Generated from CDCgov/template