CENTRIFUGE-INSPECT(1)

πŸ’– CENTRIFUGE-INSPECT β€” the manual page, but make it a vibe πŸ’–

okay bestie, so you know how centrifuge-inspect is a thing? yeah. this is that. it's the little tool that lets you peek inside a centrifuge index like it's your ex's finsta. no cap.


✨ NAME ✨

centrifuge-inspect β€” inspecting the centrifuge index πŸ”πŸ¦‹


πŸŽ€ SYNOPSIS πŸŽ€

centrifuge-inspect [options]* <cf_base>

πŸ’… DESCRIPTION πŸ’…

so this whole thing is Centrifuge version 1.0.3-beta by Daehwan Kim (infphilo@gmail.com, http://www.ccb.jhu.edu/people/infphilo). iconic behavior honestly.

🌸 <cf_base> 🌸

this is your cf filename, minus the trailing .1.cf/.2.cf/.3.cf. so like, strip the suffix and hand over the base. that's it. that's the girl.

by default? it prints FASTA records of the indexed nucleotide sequences straight to standard out. literally just dumps them. 😌

  • with -n, it only prints the names.
  • with -s, it only prints a summary of the index parameters and sequences.
  • with -e, it preserves colors if applicable. 🎨

pick your fighter, bestie.


⭐ OPTIONS ⭐

  • --large-index β€” forces inspection of the 'large' index, even if a 'small' one is sitting right there. sometimes you gotta go big, yk? πŸ’€
  • -a/--across <int> β€” how many characters go across in the FASTA output. default is 60. yes, exactly 60. she's specific like that. πŸ“
  • -n/--names β€” prints reference sequence names only. no sequences, just names. minimalism, we love her. ✨
  • -s/--summary β€” prints a summary including ref names, lengths, and index properties. the full tea. 🍡
  • -e/--bt2-ref β€” reconstructs the reference from .cf. heads up: this is slow, but it preserves colors. worth it for the aesthetic tbh. 🎨🐒
  • --conversion-table β€” prints the conversion table. πŸ“‹
  • --taxonomy-tree β€” prints the taxonomy tree. 🌳
  • --name-table β€” prints names corresponding to taxonomic IDs. 🏷️
  • --size-table β€” prints the lengths of the sequences belonging to the same taxonomic ID. πŸ“
  • -v/--verbose β€” verbose output, for debugging. she's talking a LOT now. πŸ—£οΈ
  • -h/--help β€” prints a detailed description of the tool and its options. the good kind of help. 🫢
  • --help β€” prints this usage message. (yes, both of them. they're different. don't @ me.) πŸ’€

πŸ‘‘ AUTHOR πŸ‘‘

this manpage was written by Andreas Tille for the Debian distribution, and it can be used for any other usage of the program. giving credit where credit is due, periodt. πŸ’–


and that's the whole page, bestie!! πŸŽ€βœ¨ this was centrifuge-inspect 1.0.3, dated October 2021 β€” go forth and inspect those indexes, you absolute main character. πŸ¦‹πŸ’…πŸŒˆ