<<

NAME

decode_sam_flag - print human-readable summary of bit-encoded SAM flag

SYNOPSIS

decode_sam_flag decimal_SAM_flag

DESCRIPTION

This utility takes a single decimal integer as an argument (likely taken from a SAM alignment file FLAG field), decodes the bitmasks based on the SAM specification, and prints a summary of the read properties to the screen. It can be useful during manual examination of a SAM alignment (e.g. for troubleshooting purposes).

OPTIONS

None

CAVEATS AND BUGS

Please submit bug reports to the issue tracker in the distribution repository.

AUTHOR

Jeremy Volkening (jeremy.volkening@base2bio.com)

COPYRIGHT AND LICENSE

Copyright 2016-23 Jeremy Volkening

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

<<