DBGH5(1)

πŸ¦‹ NAME πŸ¦‹

hiii bestie, welcome to the manual page for dbgh5, section 1, User Commands β€” yes it's giving big brain energy πŸ’…βœ¨

dbgh5 β€” builds a DeBruijn graph from a set of reads and saves it as a HDF5 file. that's the whole point of the girl, okay? πŸŽ€


🌸 DESCRIPTION 🌸

under the hood it's all gatb-core-library 🫢

version β€” 1.4.1 (the icon, the moment, the era) πŸ‘‘

build_kmer_size β€” 32 64 96 128 (those are the sizes it was built for, periodt)


🧚 graph options

  • -no-mphf (0 arg) β€” don't construct the MPHF. that's it, that's the option, she said no πŸ’…

πŸ“ kmer count options

  • -in (1 arg) β€” reads file πŸ“–
  • -kmer-size (1 arg) β€” size of a kmer [default '31']
  • -abundance-min (1 arg) β€” min abundance threshold for solid kmers [default '2']
  • -abundance-max (1 arg) β€” max abundance threshold for solid kmers [default '2147483647']
  • -abundance-min-threshold (1 arg) β€” min abundance hard threshold (only used when min abundance is "auto") [default '2']
  • -histo-max (1 arg) β€” max number of values in kmers histogram [default '10000']
  • -solidity-kind (1 arg) β€” way to compute counts of several files (sum, min, max, one, all, custom) [default 'sum']
  • -solidity-custom (1 arg) β€” when solidity-kind is cutom, specifies list of files where kmer must be present [default '']
  • -max-memory (1 arg) β€” max memory (in MBytes) [default '5000']
  • -max-disk (1 arg) β€” max disk (in MBytes) [default '0']
  • -solid-kmers-out (1 arg) β€” output file for solid kmers (only when constructing a graph) [default '']
  • -out (1 arg) β€” output file [default '']
  • -out-dir (1 arg) β€” output directory [default '.']
  • -out-tmp (1 arg) β€” output directory for temporary files [default '.']
  • -out-compress (1 arg) β€” h5 compression level (0:none, 9:best) [default '0']
  • -storage-type (1 arg) β€” storage type of kmer counts ('hdf5' or 'file') [default 'hdf5']

🌈 kmer count, algorithmic options options

(yes the heading says "options options", she's extra like that, we love her πŸ’œ)

  • -minimizer-type (1 arg) β€” minimizer type (0=lexi, 1=freq) [default '0']
  • -minimizer-size (1 arg) β€” size of a minimizer [default '10']
  • -repartition-type (1 arg) β€” minimizer repartition (0=unordered, 1=ordered) [default '0']

🌸 bloom options

  • -bloom (1 arg) β€” bloom type ('basic', 'cache', 'neighbor') [default 'neighbor']
  • -debloom (1 arg) β€” debloom type ('none', 'original' or 'cascading') [default 'cascading']
  • -debloom-impl (1 arg) β€” debloom impl ('basic', 'minimizer') [default 'minimizer']

πŸŽ€ branching options

  • -branching-nodes (1 arg) β€” branching type ('none' or 'stored') [default 'stored']
  • -topology-stats (1 arg) β€” topological information level (0 for none) [default '0']

⭐ general options

  • -config-only (0 arg) β€” dump config only
  • -nb-cores (1 arg) β€” number of cores [default '0']
  • -verbose (1 arg) β€” verbosity level [default '1']
  • -integer-precision (1 arg) β€” integers precision (0 for optimized value) [default '0']
  • -email (1 arg) β€” send statistics to the given email address [default '']
  • -email-fmt (1 arg) β€” 'raw' or 'xml' [default 'raw']
  • -check (1 arg) β€” check result with previous result [default '']
  • -check-dump (1 arg) β€” dump some properties of the created graph into a file [default '']

πŸ’€ debug options

these are debug girlies, don't come for them unless you know what you're doing πŸ™ˆ
  • -redo-bcalm (0 arg) β€” debug function, redo the bcalm algo
  • -skip-bcalm (0 arg) β€” same, but skip bcalm
  • -redo-bglue (0 arg) β€” same, but redo bglue
  • -skip-bglue (0 arg) β€” same, but skip bglue
  • -redo-links (0 arg) β€” same, but redo links
  • -skip-links (0 arg) β€” same, but skip links

πŸ’– AUTHOR πŸ’–

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. thank you king, the dedication is real 🫢✨


okay that's the whole page, and before you go β€” this masterpiece is dbgh5 version 1.4.1, dated May 2018, filed under DBGH5(1). it ate and left no crumbs, fr fr πŸ’…πŸ‘‘πŸŽ€