BAMALIGNFRAC(1)

✨ NAME ✨

bamalignfrac β€” bestie, it computes the fraction of aligned bases in an alignment file πŸ’…

This one's from the General Commands Manual, and yes she is that girl.


🌸 SYNOPSIS 🌸

bamalignfrac [options] <input.bam>

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so bamalignfrac reads a SAM/BAM/CRAM file, does a whole lil math moment, and prints a set of statistical values on the standard output channel. no cap. here's what she gives you:

  • the number of names passing a given regex filter πŸ‘‘
  • the number of primary alignments
  • the number of total alignments
  • the total number of bases
  • the total number of aligned bases
  • the fraction of aligned bases πŸŽ€
  • the total number of clipped/unaligned bases
  • the number of unmapped reads πŸ’€

all of these get printed on the standard output channel at the end of the program run, in the last line printed by the program. before that, the program prints a set of line description lines. so like, the receipts come first, then the ✨numbers✨.

🫢 heads up bestie: the input file needs to be provided in query name sorted order. you can get that via e.g.
$ bamsort SO=queryname

right before being passed to bamalignfrac. do not skip this step, i'm literally begging πŸ™ˆ

The following key=value pairs can be given:

  • verbose=<0|1> β€” print preliminary values for file prefixes while processing the input file πŸ‘€
  • name=<> β€” only consider reads matching the given regular expression. by default all reads are considered, no filtering, we love an inclusive queen πŸ’–

πŸ’œ AUTHOR πŸ’œ

Written by German Tischler-HΓΆhle. icon behavior fr fr.


😭 REPORTING BUGS 😭

Report bugs to <germant@miltenyibiotec.de>. she wants to hear from you, tell her everything.


Copyright Β© 2009-2019 German Tischler, Β© 2011-2013 Genome Research Limited. License GPLv3+: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it.

🚨 There is NO WARRANTY, to the extent permitted by law. (so true, so real, protect yourself)

and that's the whole page bestie, mwah πŸ’‹ β€” this was the BIOBAMBAM era, July 2019, filed under BAMALIGNFRAC(1). slay, periodt. πŸ’…βœ¨πŸŽ€