QUORUM(1)

πŸ’… QUORUM πŸ’…

okay so bestie, buckle up πŸŽ€ this is the manual page for quorum, living in the User Commands section of your friendly neighbourhood man pages, and we're in its quorum 1.1.1 era. It runs the quorum error corrector on your fastq files. Let's get into it, no cap. ✨


πŸ“– NAME πŸ“–

quorum β€” run quorum error corrector on fastq file


πŸ“– DESCRIPTION πŸ“–

(the part that's secretly the synopsis, iykyk)

quorum [options] <fastq> [fastq]

πŸ“– DESCRIPTION (part two, the actual tea) πŸ“–

So like, what it does is: it runs the quorum error corrector on the fastq file you hand it. That's the whole vibe. πŸ’–

But wait, there's a plot twist β€” if you pass the --paired-files switch, then quorum expects an even number of files on the command line, and each pair of those files is holding pair end reads. πŸ‘―

And the output? It's giving two files: <prefix>_1.fa and <prefix>_2.fa, and those contain your error corrected pair end reads. Iconic. πŸ¦‹


✨ OPTIONS ✨

so many little switches, and every single one of them matters, bestie. here we go πŸ’…

  • -s, --size β€” the Mer database size. default is 200M 🫢
  • -t, --threads β€” how many threads you wanna throw at it. default is the number of cpus, so it'll go feral on your machine by default 😭
  • -p, --prefix β€” the output prefix. default is quorum_corrected 🌸
  • -k, --kmer-len β€” the kmer length. default is 24 ✨
  • -q, --min-q-char β€” the minimum quality char. usually it's 33 or 64, and it autodetects for you, so slay πŸ’–
  • -m, --min-quality β€” the minimum above -q for a high quality base. default is 5 ⭐
  • -w, --window β€” the window size used for trimming πŸ”₯
  • -e, --error β€” the maximum number of errors allowed in a window πŸ‘‘
  • --min-count β€” the minimum count for a k-mer to be considered good 🌈
  • --skip β€” number of bases to skip to find the anchor kmer 🧚
  • --anchor β€” number of good kmer in a row for an anchor πŸ’œ
  • --anchor-count β€” the minimum count for an anchor kmer πŸŽ€
  • --contaminant β€” contaminant sequences πŸ™ˆ
  • --trim-contaminant β€” trim sequences that have contaminant mers βœ‚οΈ
  • -d, --no-discard β€” do not discard reads; instead output a single N. default is false πŸ’€
  • -P, --paired-files β€” preserve mate pairs in two files πŸ‘―
  • --homo-trim β€” trim homo-polymer on the 3' end 🌸
  • --debug β€” display debugging information πŸ›
  • --version β€” display the version 🏷️
  • -h, --help β€” this message, aka the map to the whole thing πŸ—ΊοΈ

πŸ‘‘ AUTHOR πŸ‘‘

This manpage was written by Andreas Tille for the Debian distribution, and it can be used for any other usage of the program. Respect the author bestie 🫢


okay and that's the whole page!! πŸ’– you're now fully fluent in quorum, and honestly? main character energy. go correct some reads.

signing off from the quorum 1.1.1 era, dated May 2017 β€” periodt. πŸ’…βœ¨