NTHASH(1)

🧬 NTHASH(1) β€” the manual page, but make it slay πŸ’…

okay bestie, gather round, because today we're talking about nthash β€” a recursive hash function for hashing all possible k-mers in a DNA/RNA sequence. yes. all of them. every single one. she's thorough like that. ✨

This is a User Command, iykyk. πŸ¦‹


🌸 NAME 🌸

nthash β€” Recursive hash function for hashing all possible k-mers in a DNA/RNA sequence 🧬✨


πŸŽ€ SYNOPSIS πŸŽ€

ntHash -k VAR -o VAR [-f VAR] [-h] [-s VAR] [--long] [--binary]
[--verbose] files

like… that's the whole vibe. -k and -o are the mandatory besties, everything else is optional garnish 🫢


πŸ’– DESCRIPTION πŸ’–

Unknown argument: --help

okay so FIRST OF ALL 😭 β€” if you came here hoping --help would save you, it will not. The page literally just says Unknown argument: --help. She's mysterious. She's cryptic. She's giving "figure it out, babe". πŸ’€

🐚 Positional arguments 🐚

  • files β€” Input sequence files. [nargs: 0 or more] and [required]. So like, zero-or-more of them but ALSO required?? yeah. that's the energy. bring your files. πŸ‘‘

✨ Optional arguments ✨

  • -v, --version β€” prints version information and exits. bye. ✌️
  • -k β€” k-mer size. [required] β€” no k, no party. πŸŽ‰
  • -o β€” Output file (for -f collect) or directory path. [required] β€” you gotta tell her where to put the goods. πŸ“
  • -f β€” Output file organization. You can store hashes for each 'file', for each 'record', or 'collect' all hashes into a single file. [default: "file"] 🌈
  • -h β€” Number of hashes per k-mer/seed. [default: 1] β€” ngl, if you expected this to be "help", it is NOT, bestie, it is the hash count. πŸ™ˆ
  • -s β€” Input spaced seed patterns separated by commas (e.g. 1110111,11011011). Performs k-mer hashing if no value provided. 🧚
  • --long β€” Optimize file reader for long sequences (>5kbp). long queen behavior πŸ‘‘
  • --binary β€” Output hashes in binary files (otherwise plain text). πŸ”₯
  • --verbose β€” Print progress to stdout. she'll narrate her journey for you 🎀

πŸ’œ AUTHOR πŸ’œ

This manpage was written by Nilesh Patra for the Debian distribution and can be used for any other usage of the program. 🫢 iconic of them honestly.


and that's the whole page, bestie!! this was nthash version 2.3.0, dated October 2022, from the NTHASH(1) manual. periodt. πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from