GRAPHDUMP(1)

πŸ’– GRAPHDUMP β€” the manual, but make it cute πŸ’–

okay bestie, sit down, hydrate, and let's talk about graphdump β€” a lil user-commands baddie whose whole job is building the compacted de Bruijn graph from many complete genomes. yes fr fr, genomes. plural. she's a crowd-pleaser. 🌸


✨ DESCRIPTION ✨

so here's the whole vibe, the USAGE, the tea, all of it:

graphdump
       -k <integer> [-s <>] ... -f <seq|group|dot|gfa1|gfa2|fasta>
       [--prefix] [--] [--version] [-h] <file name>

and now, where each of those lil guys goes:

  • -k <integer>, --kvalue <integer> β€” (required, no skipsies πŸ’…) this is your Value of k. the k. THE k. it needs an integer, so don't get cute with it.
  • -s <>, --seqfile <> β€” (and yes, it's accepted multiple times, so go off πŸ‘‘) this one's the sequences file name.
  • -f <seq|group|dot|gfa1|gfa2|fasta>, --format <seq|group|dot|gfa1|gfa2|fasta> β€” (required) the Output format. pick one of those six and only one, bestie, no mixing.
  • --prefix β€” adds a prefix to segments in GFA. genuinely iconic if you happen to have genomes with identical FASTA headers. the way that identical FASTA headers would otherwise cause chaos… not on her watch. 🫢
  • --, --ignore_rest β€” Ignores the rest of the labeled arguments following this flag. like, straight up, everything after it gets ghosted. πŸ™ˆ
  • --version β€” Displays version information and exits. short queen behaviour.
  • -h, --help β€” Displays usage information and exits. your emotional support flag. ✨
  • <file name> β€” (required) the input file name. yes it's positional. yes it still counts. no you cannot skip it. 😭
ngl the (required) tags are not suggestions. the program will simply not be doing it without them. respect the requirements, periodt.

🌈 what she actually does 🌈

This utility converts the binary output of TwoPaCo to another format.

that's it, that's the plot. she takes TwoPaCo's binary output and gives it a whole new look β€” main character energy, but make it a different format. πŸ’–


πŸ‘‘ AUTHOR πŸ‘‘

This manpage was written by Andrius Merkys for the Debian distribution and can be used for any other usage of the program.

shoutout to Andrius for penning this whole thing for Debian, and for keeping it free to use however else you wanna use it. we love a generous king. πŸŽ€


and that's the page, babes. πŸ¦‹ this is graphdump version 1.0.0, dated September 2022 β€” write that down, cite it, put it in your notes app, whatever. mwah πŸ’…β­