Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 3.96 KB

index.md

File metadata and controls

96 lines (70 loc) · 3.96 KB

Command reference

dada2-rs <subcommand> --help prints a one-line summary for every flag, grouped into categories. These pages carry the detail that does not fit on one line: what a parameter actually does, when to change it, and what the evidence behind its default is.

Reading --help

Flags are grouped under a fixed set of headings, used consistently across every subcommand:

Heading What it holds
Input Input files, sample naming, Phred offset
Error model The error model file, fitting function, and its knobs
Denoising The DADA2 algorithm parameters (R's setDadaOpt() surface)
Pseudo-pooling Prior selection between the two dada-pseudo rounds
Alignment Needleman-Wunsch scoring, band radius, aligner backend
Screening The pre-alignment k-mer screen that decides which pairs are aligned
Trimming Truncation and end-trimming of reads
Filtering Read- or sequence-level discard rules
Primers Primer sequences and matching tolerance
Merging Paired-end overlap and concatenation rules
Chimera Bimera and trimera detection parameters
Classification Taxonomic assignment thresholds
Metrics Optional per-read metrics (summary, summary-merge)
Pooling regime Which population is scored, and how it is sampled (kdist-calibrate)
Evaluation Truth-set classification thresholds (reference-eval)
Performance Threads and concurrency; never affects results
Diagnostics Extra output for QC and debugging; never affects ASVs
Experimental Unstable flags. Off by default, and not drop-in replacements

Two headings are worth reading as a pair. Denoising parameters define the clusters; Screening parameters only decide which pairs are worth aligning in the first place. A screen flag can change runtime by orders of magnitude and can, if set too aggressively, cost you real ASVs — but it is not part of the algorithm's definition of an ASV.

Anything under Performance or Diagnostics is safe to change without affecting the ASV table.

Pages

Quality assessment

  • summary — per-position quality metrics from a FASTQ file
  • summary-merge — union per-sample summaries into a run report

Read preparation

Error models

Denoising

Tables and chimeras

Taxonomy

Converters

Calibration and evaluation

See also