Skip to content

snipe sketch

Create a k-mer sketch signature from sample reads or a genome reference.

Terminal window
snipe sketch [OPTIONS]
FlagTypeRequiredDefaultDescription
-o, --outputtextyesOutput signature path (canonically *.snipesig, Parquet-encoded).
--sampletextnoSample FASTA/FASTQ path(s) -> one signature (repeat for multiple files). Pass ’-’ to stream a single FASTA/FASTQ from stdin; ’-’ cannot be mixed with file paths.
--genometextnoGenome FASTA path -> one reference-with-coordinates signature. Accepts exactly one file.
--k1-sizeintegerno51K1 size (prefix k-mer).
--k2-sizeintegerno53K2 size (extended k-mer, must be >= k1_size).
--scaleinteger rangeno10000Scale factor for hash-space sampling.
--min-seq-lengthintegernoMinimum sequence length to process.
--max-sequencesintegernoMaximum number of sequences (0 = unlimited).
--keep-acgtflagnooffKeep k-mer sequences in the output.
--input-formatfastx | sranoInput format (auto-detected by default).
--nametextnoCustom signature name (the signature has no stored name unless this is set).