<<

NAME

bam2consensus - consensus calling (etc) from BAM alignment

SYNOPSIS

bam2consensus --bam <in.bam> --ref <in.fasta> [options] --consensus <out.fasta>

DESCRIPTION

Re-calls a consensus sequence based on a BAM alignment to reference, with various knobs and optional output formats

PREREQUISITES

Requires the following non-core Perl libraries:

as well as the following binaries:

OPTIONS

Input (required)

--bam filename

Path to input BAM alignments

--ref filename

Path to reference sequence used to generate BAM alignments

Output (at least one is required, can specify more than one)

--consensus

Path to write consensus sequence to (as FASTA)

--bedgraph

Path to write coverage file to (as bedgraph)

--table

Path to write coverage file to (as tab-separated table)

Configuration

--min_qual

Minimum quality for a base to be considered in consensus calling. Default: 10.

--min_depth

Minimum read depth for consensus to be called (otherwise called as "N"). Default: 3.

--trim

Fraction to trim from each end when calculating trimmed mean of error window. Default: 0.2.

--window

Size of sliding window used to calculate local error rates. Default: 30.

--bg_bin_figs <integer>

If greater than zero, the number of significant figures used to bin depths in bedgraph output. If zero, no binning is applied. This option is useful to reduce the size of bedgraph output by binning similar depth values when high resolution is not important. Default: 0 (disabled).

CAVEATS AND BUGS

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

AUTHOR

Jeremy Volkening (jeremy.volkening@base2bio.com)

LICENSE AND COPYRIGHT

Copyright 2014-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/>.

<<