Microbial & metagenomicslatest-release

viralintegration

nf-core/viralintegration

Integration of viral sequences in genomic data

version0.1.170e558aaffJul 19, 2023 Upstream Usage docs

Key tools

FastQCIGVMultiQCSAMtoolsSTARTRIMMOMATICPandasTidyverse

Run it

nfclaw

nfclaw run viralintegration --input samplesheet.csv --outdir results -profile docker

raw nextflow

nextflow run pipelines/viralintegration/upstream -profile docker --input samplesheet.csv --outdir results

demo · bundled test profile

nfclaw run viralintegration --demo --outdir results   # adds the upstream test profile (-profile test,docker)

Inputs

column	type	required	constraints
`sample`	string	yes	matches `^\S+$`
`fastq_1`	string	yes	matches `^\S+\.f(ast)?q\.gz$`
`fastq_2`	string	no

--input must match ^\S+\.csv$.

The samplesheet is a CSV with this header (the columns the schema requires); fill each value per the table above and reference.md (no example value is invented here):

csv

sample,fastq_1

Any of the optional columns above may be appended to the header when your data needs them: fastq_2.

From data files. --input may also be the data files — a directory (searched recursively), a quoted glob, or files (--input once per file) — from which nfclaw writes this samplesheet: sample from file names; fastq_1/fastq_2 from FastQ files (mates paired by _R1/_R2, or by _1/_2 when their read names show they are mates). Set other columns with --sheet-set COLUMN=VALUE. Preview it with --check; a run records it in <outdir>/provenance/ for replay.

Reference genome

No reference genome is set by default: supply your own reference. The schema declares AWS iGenomes at s3://ngi-igenomes/igenomes; selecting --genome <id> uses the paths in the pipeline's reference configuration. Access to that remote source is required. To supply your own reference, use e.g. --fasta; the reference_genome_options group in reference.md lists every reference option. Set --igenomes-ignore true to disable the lookup entirely. Confirm the selected reference's paths and source in the pinned upstream/nextflow.config and upstream/conf/ before running.

Resources

Resource requests follow the pipeline's configs and selected profiles. nf-core's resource labels often assume a server — a single step can request far more memory than a workstation has, and retry rules can increase requests. If a run fails with Process requirement exceeds available memory (or CPUs), cap every request, and every retry, at what this machine actually has:

bash

nfclaw run viralintegration --input samplesheet.csv --outdir results -profile docker \
  --limit-cpus 4 --limit-memory 15.GB

nfclaw turns those into Nextflow's process.resourceLimits and passes them as a -c config — the mechanism nf-core prescribes for exactly this (docs). Set them to the machine's real capacity. --limit-time DURATION also caps how long any one task may run: a task that needs longer is stopped, and so is every retry, so set it only as a deliberate ceiling, never as a guess at how long the analysis takes. The generated config is kept in <outdir>/provenance/, so commands.sh replays the run under the same ceiling.

Nextflow engine

This release declares nextflowVersion = '!>=23.04.0'.

To pin this release's declared minimum engine — useful when a newer Nextflow has incompatible config parsing:

bash

nfclaw run viralintegration ... --nxf-ver 23.04.0

--nxf-ver is recorded in <outdir>/provenance/, so the replay uses the same engine. See known-issues.

Nextflow 23.04.0 predates process.resourceLimits (24.04.0), so --limit-* cannot be combined with this pin — nfclaw refuses it rather than run without the ceiling; cap resources with the release's own --max-cpus, --max-memory, --max-time instead.

Demo

bash

nfclaw run viralintegration --demo --outdir results   # adds the upstream test profile (-profile test,docker)

Samplesheet

A CSV with this header (the columns the schema requires). Fill each value per the constraints below; optional columns from the table may be appended.

samplesheet.csv header

sample,fastq_1

Column	Type	Required	Allowed / constraints
`sample`	string	required	matches ^\S+$
`fastq_1`	string	required	matches ^\S+\.f(ast)?q\.gz$
`fastq_2`	string	optional	—

Required parameters

--inputstring (file path)

Path to comma-separated file containing information about the samples in the experiment.

Constraint · matches ^\S+\.csv$

--viral-fastastring (file path)

Path to fasta file with viral genomes

Constraint · matches ^\S+\.fn?a(sta)?(\.gz)?$

--outdirstring (directory path)

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

--min-readsinteger

Minimum reads

Constraint · ≥ 1

--max-hitsinteger

Maximum hits

Constraint · ≥ 1

--remove-duplicatesboolean

To remove duplicate viral hits or not

Parameter explorer

37 parameters · 5 groups

Every parameter from the pinned nextflow_schema.json. nfclaw checks explicit values before launch; complex rules use the pinned pipeline's runtime validation. Search, filter by group, and expand any parameter for its default, allowed values and constraints.

Groups

nextflow_schema.json

12 parameters · 25 hidden

Generic options1

Custom MultiQC yaml file containing HTML including a methods description.

Input Output options8

Email address for completion summary.

Path to comma-separated file containing information about the samples in the experiment.

Maximum hits

Minimum reads

MultiQC report title. Printed as page header, used for filename if not otherwise specified.

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

To remove duplicate viral hits or not

Path to fasta file with viral genomes

Reference Genome options3

Path to FASTA genome file.

Name of iGenomes reference.

Path to GTF annotation file.

Outputs

Results land in --outdir; the files and directory layout depend on the selected workflow, parameters and publication settings. Run metadata is normally placed in <outdir>/pipeline_info/ (execution report, software versions), when those outputs are enabled. The pinned tree includes MultiQC support; a report is produced only when its workflow step runs. nfclaw run also writes <outdir>/provenance/ with the exact params file and the run log, <outdir>/provenance/logs/run.log — the whole launch, whose last line states the outcome (Nextflow's own log is <outdir>/.nextflow.log); unless --no-provenance it adds a run manifest (pinned version, commit and exact command), input/output SHA-256 checksums, and a replayable commands.sh. The exact output files and directory layout for this release are documented upstream: github.com/nf-core/viralintegration/blob/0.1.1/docs/output.md Check a run — in the foreground or the background — with nfclaw status <outdir>: success, still running, how it ended (with the error), or stopped without an outcome; exit 0 success, 3 running, 1 otherwise.