MASH-TRIANGLE(1)
π MASH-TRIANGLE(1) π
okay bestie, welcome to the mash-triangle manual page, straight out of section 1 of the manual, and no cap it's a good one π¦
β¨ NAME β¨
mash-triangle β estimate a lower-triangular distance matrix π
πΈ SYNOPSIS πΈ
mash triangle [options] <seq1> [<seq2>] ...
π DESCRIPTION π
So what this does, bestie, is it estimates the distance of each input sequence to every other input sequence. The way it gives it to you is a lower-triangular distance matrix, written out in relaxed Phylip format π
Your input sequences can be literally any of these:
- fasta
- fastq
- gzipped or not (either one, we don't judge) π«Ά
- Mash sketch files (
.msh) β but only ones with matching k-mer sizes, okay? mismatched k-mer sizes is not the vibe.
Input files can also be files of file names β peep -l for that one π
And if you hand it more than one input file, then by default it compares whole files against each other. Want it to compare individual sequences instead? That's -i. iykyk β¨
π OPTIONS π
-hβ Help. the classic. ask and ye shall receive π-p <int>β Parallelism, bestie. This many threads will be spawned for processing. Default is[1]. go on, give it more, she can handle it π₯
π¦ Input π¦
-lβ List input. Each query file contains a list of sequence files, one per line. The reference file is not affected by this. periodt.
π Output π
-Cβ Use comment fields for sequence names instead of IDs. cute names, no numbers π-Eβ Output an edge list instead of a Phylip matrix. The fields are[seq1, seq2, dist, p-val, shared-hashes]. iconic format honestly β¨-v <num>β Maximum p-value to report in the edge list. Implies-E. Range is(0-1), default[1.0].-d <num>β Maximum distance to report in the edge list. Implies-E. Range is(0-1), default[1.0].
π§ Sketching π§
-k <int>β K-mer size, babes. Hashes will be based on strings of this many nucleotides. Canonical nucleotides are used by default β go look at the Alphabet options below for the tea. Range is(1-32), default[21]β-s <int>β Sketch size. Each sketch will have at most this many non-redundant min-hashes. Default[1000]π-iβ Sketch individual sequences rather than whole files. This is the one you want for multi-fastas of single-chromosome genomes, or for pair-wise gene comparisons. so specific, so useful π-w <num>β Probability threshold for warning about low k-mer size. Range(0-1), default[0.01]π-rβ Input is a read set. Go check the Reads options below. Incompatible with-iβ pick a lane bestie, you cannot have both π«
π Sketching (reads) π
-b <size>β Use a Bloom filter of this size (raw bytes, or withK/M/G/T) to filter out unique k-mers. Super useful if exact filtering with-mis eating too much memory. But heads up: some unique k-mers may pass erroneously, and copies cannot be counted beyond 2. Implies-r. β οΈ-m <int>β Minimum copies of each k-mer required to pass the noise filter for reads. Implies-r. Default[1].-c <num>β Target coverage. Sketching will conclude if this coverage is reached before the end of the input file (estimated by average k-mer multiplicity). Implies-r. β¨-g <size>β Genome size. If you specify it, it'll be used for p-value calculation instead of an estimated size from k-mer content. Implies-r. πΈ
π Sketching (alphabet) π
-nβ Preserve strand. By default, strand is ignored by using canonical DNA k-mers, which are the alphabetical minima of forward-reverse pairs. Implied if an alphabet is specified with-aor-z. π§¬-aβ Use the amino acid alphabet (A-Z, exceptBJOUXZ). Implies-n,-k 9. π-z <text>β Alphabet to base hashes on (case ignored by default; see-Z). K-mers with other characters will be ignored. Implies-n. π«-Zβ Preserve case in k-mers and alphabet (case is ignored by default). Sequence letters whose case is not in the current alphabet will be skipped when sketching. π
π SEE ALSO π
mash(1)β go read that one too, bestie, they're a set π«Ά
and that's the whole page!! go forth and triangle your distances, you absolute main character π β¨
this page is from the MASH-TRIANGLE(1) manual, dated 2019-12-13 β yeah she's an oldie but a goodie, still slaying after all this time ππ
π¦ where this page comes from
- debian bookworm: mash 2.3+dfsg-3+b1 Β· BSD-3-Clause
- debian trixie: mash 2.3+dfsg-6+b2 Β· BSD-3-Clause
- ubuntu jammy: mash 2.3+dfsg-1build2 Β· BSD-3-Clause
- ubuntu noble: mash 2.3+dfsg-6 Β· BSD-3-Clause
- ubuntu questing: mash 2.3+dfsg-6build2
- ubuntu resolute: mash 2.3+dfsg-6build3 Β· BSD-3-Clause
- ubuntu stonking: mash 2.3+dfsg-6build4 Β· BSD-3-Clause
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms