BAMFILTERHEADER2(1)

💖 bamfilterheader2(1) — General Commands Manual 💖

okay bestie, sit down, hydrate, and let me tell you about bamfilterheader2 from the Biobambam fam. it's giving "tiny utility, huge glow-up for your BAM files." ✨

🌸 NAME 🌸

bamfilterheader2 — filter auxiliary tags from BAM file 🧹🦋

✨ SYNOPSIS ✨

bamfilterheader2 [options]

👑 DESCRIPTION 👑

okay so here's the whole vibe: bamfilterheader2 reads a BAM file from a file, filters the header, and writes the resulting data to standard output as a BAM file. slay. 💅

and what does "filtering the header" mean? it means it's removing sequence (SQ) lines and read group (RG) lines which are not referenced in any alignment. like, if nobody's using them, they gotta go. main character energy only. 🔥

⚠️ heads up bestie: the input file is scanned twice during the process, so the name of the input file needs to be provided using the I key. no cap.

the following key=value pairs can be given, where the keep and remove keys are mutually exclusive. 🙈

• I=<inputfilename>: name of input BAM file 📂
• level=<-1|0|1|9|11>: set compression level of the output BAM file. valid values are:
  • -1: zlib/gzip default compression level
  • 0: uncompressed
  • 1: zlib/gzip level 1 (fast) compression
  • 9: zlib/gzip level 9 (best) compression

if libmaus has been compiled with support for igzip (see https://software.intel.com/en-us/articles/igzip-a-high-performance-deflate-compressor-with-optimizations-for-genomic-data) then an additional valid value is:

• 11: igzip compression ⚡

• verbose=<1>: valid values are:
  • 1: print progress report on standard error
  • 0: do not print progress report
• tmpfile=<filename>: prefix for temporary files. by default the temporary files are created in the current directory 📁
• md5=<0|1>: md5 checksum creation for output file. valid values are:
  • 0: do not compute checksum. this is the default. 🙅‍♀️
  • 1: compute checksum. if the md5filename key is set, then the checksum is written to the given file. if md5filename is unset, then no checksum will be computed.
• md5filename file name for md5 checksum if md5=1. 🔐
• index=<0|1>: compute BAM index for output file. valid values are:
  • 0: do not compute BAM index. this is the default. 🙅
  • 1: compute BAM index. if the indexfilename key is set, then the BAM index is written to the given file. if indexfilename is unset, then no BAM index will be computed.
• indexfilename file name for BAM index if index=1. 🗂️

🫶 AUTHOR 🫶

Written by German Tischler. 💜 (we love a legend)

😭 REPORTING BUGS 😭

Report bugs to <germant@miltenyibiotec.de> — pls be nice, fr fr.

🎀 COPYRIGHT 🎀

Copyright © 2009-2014 German Tischler, © 2011-2014 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. 💀 (read that part again bestie, it's important)

Biobambam · January 2014 · that's the whole page babes, go filter those headers and slay the day 💖✨🎀🦋🌸💅