QUORUM_CREATE_DATABASE(1)

πŸ’– QUORUM_CREATE_DATABASE πŸ’–

okay bestie, welcome to quorum_create_database β€” it's a User Command, it's lowkey iconic, and it does exactly one thing but it does it so well. πŸ’…


✨ NAME ✨

quorum_create_database β€” build a database of k-mers for the quorum error corrector. no cap.


🌸 SYNOPSIS 🌸

create_database_cmdline [options] reads:path+

like... options first, then your reads, and bestie you can pass more than one path. the + is not a suggestion, it's a requirement. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

So what are we even doing here? We're creating a database of k-mers for the quorum error corrector. That's the vibe. That's the whole assignment.

More specifically: it creates the k-mer database for quorum_error_correct. You make the database here, then that other tool gets to eat. main character energy for real. ✨


πŸŽ€ OPTIONS πŸŽ€

quick heads up before we dive in: the default value is sitting in the () β€” and the ones with a * are required, as in, you literally cannot skip them, bestie, the program will simply not.

  • -s, --size=uint64 β€” *Initial hash size. REQUIRED. you don't get to skip this one. πŸ’€
  • -m, --mer=uint32 β€” *Mer length. also required. pick your k and commit. 🧚
  • -b, --bits=uint32 β€” *Bits for value field. required, bestie, all three of these asterisk babes are mandatory.
  • -q, --min-qual-value=uint32 β€” min quality, but as an int. numbers only. πŸ”’
  • -Q, --min-qual-char=string β€” min quality, but as an ASCII character. yes it's the same concept in a different outfit. the duality. ✨
  • -t, --threads=uint32 β€” number of threads. default is (1). one thread, one little worker bee 🐝 β€” bump it up if you want her to go faster.
  • -o, --output=path β€” output file. default is (combined_database). that's the name it'll use if you don't say otherwise. πŸ“
  • -p, --reprobe=int32 β€” maximum number of reprobes. default is (126). yes, one hundred and twenty six, very specific, we love her. πŸ’œ
  • -U, --usage β€” usage. just the usage. πŸ™ˆ
  • -h, --help β€” this message. hello, it's me. πŸ‘‹
  • -V, --version β€” version. so you know which one you're running. ⭐

πŸ‘‘ AUTHOR πŸ‘‘

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. iconic of him honestly. 🌈


okay that's the whole page, bestie β€” go forth and build those k-mer databases. vibe check passed, no notes. πŸ’–βœ¨πŸŽ€

version quorum_create_database 1.1.1, dated May 2017, straight out of the quorum family. mwah. πŸ’…πŸ¦‹