Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tool reference

Each page has a short description, typical usage, and the command’s full --help.

commandwhat it does
strlenper-read repeat-tract lengths at indel calls (for repeat-length features)
pileupallele read counts by MAPQ at SNP and indel calls (for pileup features)
extractper-call features (and labels, for training) as a Parquet feature table
subsetrestrict a labelled feature table to some contigs, or away from some regions
traintrain a model for one variant type; thresholds chosen by cross-validation
evaluateF1 of a model’s decisions on a held-out labelled sample
stratifydecisions, F1 and P(keep) calibration by benchmark stratum and GIAB stratification
scoreapply models to a sample and write the re-genotyped, filtered VCF

Global options

Machine-learned genotyping and filtering of germline small-variant calls

Usage: winnowr [OPTIONS] <COMMAND>

Commands:
  extract   Extract a feature table for a sample's calls, optionally labelled with truth
  train     Train a genotype or promote model from labelled feature tables
  evaluate  Report F1 for models' decisions on a labelled sample
  stratify  Report models' decisions, outcomes, F1 and P(keep) calibration by benchmark stratum
  score     Score a sample's calls and write a VCF with drops, promotions, flips and re-genotypes
  strlen    Measure read lengths across repeat tracts at indel calls (repeat-length evidence)
  pileup    Count the reads of each call's alleles by MAPQ, at any MAPQ (pileup evidence)
  subset    Restrict a labelled feature table to some of its contigs, or away from some regions
  help      Print this message or the help of the given subcommand(s)

Options:
  -t, --threads <THREADS>  The number of worker threads to use [default: OMP_NUM_THREADS when set,
                           else 4]
  -h, --help               Print help
  -V, --version            Print version

-t/--threads is accepted by every command; see Performance tuning. Logging goes to standard error, at the info level by default; set RUST_LOG (e.g. RUST_LOG=winnowr=debug) to change it.