Skip to content

snipe qc

Compute quality-control metrics for sample signatures against a reference.

Terminal window
snipe qc [OPTIONS]
FlagTypeRequiredDefaultDescription
--referencetextyesReference .snipesig signature file.
-o, --outputtextyesOutput TSV file for QC results.
--sampletextnoSample .snipesig signature file path(s) (repeat for multiple; mutually exclusive with —samples-list).
--samples-listtextnoFile listing sample .snipesig paths, one per line (mutually exclusive with —sample).
--roi-sigtextnoOptional region-of-interest .snipesig signature (K1-only SnipeSignature); mutually exclusive with —roi-bed.
--roi-bedtextnoOptional region-of-interest BED of genomic intervals, resolved against the reference’s stored coordinates (reference must be a sketch --genome signature); mutually exclusive with —roi-sig.
--ychrtextnoOptional Y chromosome .snipesig signature file (for samples missing Y).
--vartextnoOptional variance signature file(s) for contamination detection (repeat for multiple).
--advancedflagnooffInclude verbose-tier metrics in the output.
--hiddenflagnooffInclude hidden developer-only metrics (not shown in help).