KMDS(1)
π KMDS β control for population structure π
okay bestie, listen up, this is kmds, a little icon from the User Commands corner of the manual. she controls for population structure, filters kmers, and builds you a matrix that represents population structure. she's part of the seer(1) family, aka Sequence Element (kmer) Enrichment Analysis β so if you already know seer, you already kinda know her vibe. iykyk β¨
β¨ DESCRIPTION β¨
so what does she actually do? Control for population structure. she filters kmers and creates a matrix representing population structure. that's the whole gig, and she eats every time π
she belongs to seer(1), the Sequence Element (kmer) Enrichment Analysis situation β so think of her as one of the main characters in that whole ensemble cast. π
π OPTIONS π
the two iconic workflows, no cap:
- filter and subsample with
--no_mdsand--size - combine, and do metric multidimensional scaling with
--mds_concat
π¦ Required options π¦
these are non-negotiable, bestie. like, she literally will not go anywhere without them.
-k,--kmersarg β the dsm kmer output file. this is your input, your whole reason for being here π«Ά-p,--phenoarg β the.phenometadata. the pheno file, the personality file, the lore.
πΈ MDS options πΈ
this is the multidimensional scaling section, and she is obsessed with it.
-o,--outputarg β output prefix for the new dsm file.--no_mdsβ do not perform MDS; instead she outputs the subsampled matrix. just the matrix, no scaling, no drama. π--write_distancesβ writes a csv of the distance matrix. give the people the csv!! π--mds_concatarg β a list of subsampled matrices to use in MDS. note that this performs only MDS; it implies--no_filtering. so like, filtering is off the table the second you use this, periodt.--pcarg (=3) β number of principal coordinates to output. default is3, which is honestly a serve.--sizearg (=1000000) β number of kmers to use in MDS. default is1000000(a whole million, she's not doing anything small π).--threadsarg (=1) β number of threads. default is1. suggested:4. so like, crank it up if your machine can handle the main character energy. π₯
π Filtering options π
the filter era. very demure, very mindful.
--no_filteringβ turn off all filtering and do not output a new kmer file. everything stays, nothing new gets written. it's giving chaos but make it intentional.--max_lengtharg (=100) β maximum kmer length. default100.--mafarg (=0.01) β minimum kmer frequency. default0.01. (maf = minor allele frequency energy, keep it in mind π§)--min_wordsarg β minimum kmer occurrences. Overrides--maf. so if you set both, this one wins. she said "i'm the captain now". π
β Other options β
--versionβ prints version and exits. one and done, bye π-h,--helpβ full help message. when in doubt, ask her.
π EXAMPLE π
want to filter kmers and create a matrix representing population structure with kmds? here's the move:
kmds -k dsm_input.txt.gz --pheno metadata.pheno -o filtered
and if you want to spread this process out, run the following command on each dsm file:
kmds -k dsm_input.txt.gz --pheno metadata.pheno --no_mds --size 10000
copy it exactly, bestie, don't freestyle the flags. π
π AUTHOR π
this manpage was written by Andreas Tille for the Debian distribution, and can be used for any other usage of the program. shoutout to Andreas fr fr π
ok that's the whole page!! everything she does, every flag, every default, all of it. no cap. π
and a lil sign-off for the girls and the gays and everyone in between: this is kmds version 1.1.2, dated March 2017. vintage but she still slays. πβ¨π¦
π¦ where this page comes from
- debian bookworm: seer 1.1.4-7 Β· GPL-2.0-or-later
- debian trixie: seer 1.1.4-8+b1 Β· GPL-2.0-or-later
- ubuntu jammy: seer 1.1.4-6 Β· GPL-2.0-or-later
- ubuntu noble: seer 1.1.4-7build4 Β· GPL-2.0-or-later
- ubuntu questing: seer 1.1.4-8build3
- ubuntu resolute: seer 1.1.4-8build5 Β· GPL-2.0-or-later
- ubuntu stonking: seer 1.1.4-9build1 Β· GPL-2.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms