SIMKAMERGE(1)

πŸ’– SIMKAMERGE(1) πŸ’–

okay bestie, so this is the manual page for simkaMerge β€” a comparative metagenomics method dedicated to NGS datasets ✨. It lives in section 1 of the manual, aka User Commands, which is the chill "these are programs you can just run" section. Pull up a chair, grab a boba πŸ§‹, and let's get into it.


πŸŽ€ NAME πŸŽ€

simkaMerge β€” comparative metagenomics method dedicated to NGS datasets. that's the whole vibe. πŸ¦‹


✨ DESCRIPTION ✨

so like, when you run this thing with the wrong energy (specifically with -h), it does NOT hold back. here's the literal receipts it hands you, and yes it's giving "I asked for one thing and got seven complaints" 😭:

ERROR: Unknown parameter '-h'
ERROR: Option '-nb-cores' is mandatory
ERROR: Option '-kmer-size' is mandatory
ERROR: Option '-in' is mandatory
ERROR: Option '-out-tmp-simka' is mandatory
ERROR: Option '-partition-id' is mandatory
ERROR: Option '-nb-cores' is mandatory
ERROR: Option '-max-memory' is mandatory
ERROR: Option '-kmer-shannon-index' is mandatory
lowkey important: notice that -nb-cores gets flagged as mandatory twice in that list. that's not me being extra, that's literally what the page says. πŸ™ˆ

🌸 [SimkaMerge options] 🌸

every single one, no skips, no cuts, we're listing the whole roster πŸ’…:

  • -nb-cores β€” (1 arg) : number of cores [default '0']
  • -verbose β€” (1 arg) : verbosity level [default '1']
  • -version β€” (0 arg) : version
  • -help β€” (0 arg) : help
  • -nb-cores β€” (1 arg) : nb cores
  • -kmer-size β€” (1 arg) : kmer size
  • -in β€” (1 arg) : input filename
  • -out-tmp-simka β€” (1 arg) : tmp output
  • -partition-id β€” (1 arg) : bank name
  • -nb-cores β€” (1 arg) : bank name
  • -max-memory β€” (1 arg) : bank name
  • -kmer-shannon-index β€” (1 arg) : bank name
  • -simple-dist β€” (0 arg) : compute simple distances
  • -complex-dist β€” (0 arg) : compute complex distances
not me pointing this out again but: -nb-cores is listed three whole times in this section β€” once as "number of cores", once as "nb cores", and once as "bank name". the other three "bank name" entries (-partition-id, -max-memory, -kmer-shannon-index) are just out here wearing the exact same description. iconic behavior, honestly. πŸ‘‘

πŸ‘‘ AUTHOR πŸ‘‘

This manpage was written by Shayan Doust for the Debian distribution, and it can be used for any other usage of the program. periodt. πŸ’œ


k that's the whole page bestie, you ate it, no crumbs left πŸ“ this was simkaMerge version 1.5.1, dated September 2019, and you can find it filed under SIMKAMERGE(1). go forth and merge those datasets, main character 🫢✨