NAME

SYNOPSIS

DESCRIPTION

A summary of output sections is listed below, followed by more detailed descriptions.

Not all sections will be reported as some depend on the data being coordinate sorted while others are only present when specific barcode tags are in use.

Some of the statistics are collected for “first” or “last” fragments. Records are put into these categories using the PAIRED (0x1), READ1 (0x40) and READ2 (0x80) flag bits, as follows:

• Unpaired reads (i.e. PAIRED is not set) are all “first” fragments. For these records, the READ1 and READ2 flags are ignored.
• Reads where PAIRED and READ1 are set, and READ2 is not set are “first” fragments.
• Reads where PAIRED and READ2 are set, and READ1 is not set are “last” fragments.
• Reads where PAIRED is set and either both READ1 and READ2 are set or neither is set are not counted in either category.

Information on the meaning of the flags is given in the SAM specification document <https://samtools.github.io/hts-specs/SAMv1.pdf>.

The CHK row contains distinct CRC32 checksums of read names, sequences and quality values. The checksums are computed per alignment record and summed, meaning the checksum does not change if the input file has the sort-order changed.

The SN section contains a series of counts, percentages, and averages, in a similar style to samtools flagstat, but more comprehensive.

The FFQ and LFQ sections report the quality distribution per first/last fragment and per cycle number. They have one row per cycle (reported as the first column after the FFQ/LFQ key) with remaining columns being the observed integer counts per quality value, starting at quality 0 in the left-most row and ending at the largest observed quality. Thus each row forms its own quality distribution and any cycle specific quality artefacts can be observed.

GCF and GCL report the total GC content of each fragment, separated into first and last fragments. The columns show the GC percentile (between 0 and 100) and an integer count of fragments at that percentile.

GCC, FBC and LBC report the nucleotide content per cycle either combined (GCC) or split into first (FBC) and last (LBC) fragments. The columns are cycle number (integer), and percentage counts for A, C, G, T, N and other (typically containing ambiguity codes) normalised against the total counts of A, C, G and T only (excluding N and other).

GCT offers a similar report to GCC, but whereas GCC counts nucleotides as they appear in the SAM output (in reference orientation), GCT takes into account whether a nucleotide belongs to a reverse complemented read and counts it in the original read orientation. If there are no reverse complemented reads in a file, the GCC and GCT reports will be identical.

FTC and LTC report the total numbers of nucleotides for first and last fragments, respectively. The columns are the raw counters for A, C, G, T and N bases.

BCC, CRC, OXC and RXC are the barcode equivalent of GCC, showing nucleotide content for the barcode tags BC, CR, OX and RX respectively. Their quality values distributions are in the QTQ, CYQ, BZQ and QXQ sections, corresponding to the BC/QT, CR/CY, OX/BZ and RX/QX SAM format sequence/quality tags. These quality value distributions follow the same format used in the FFQ and LFQ sections. All these section names are followed by a number (1 or 2), indicating that the stats figures below them correspond to the first or second barcode (in the case of dual indexing). Thus, these sections will appear as BCC1, CRC1, OXC1 and RXC1, accompanied by their quality correspondents QTQ1, CYQ1, BZQ1 and QXQ1. If a separator is present in the barcode sequence (usually a hyphen), indicating dual indexing, then sections ending in "2" will also be reported to show the second tag statistics (e.g. both BCC1 and BCC2 are present).

IS reports insert size distributions with one row per size, reported in the first column, with subsequent columns for the frequency of total pairs, inward oriented pairs, outward orient pairs and other orientation pairs. The -i option specifies the maximum insert size reported.

RL reports the distribution for all read lengths, with one row per observed length (up to the maximum specified by the -l option). Columns are read length and frequency. FRL and LRL contains the same information separated into first and last fragments.

ID reports the distribution of indel sizes, with one row per observed size. The columns are size, frequency of insertions at that size and frequency of deletions at that size.

IC reports the frequency of indels occurring per cycle, broken down by both insertion / deletion and by first / last read. Note for multi-base indels this only counts the first base location. Columns are cycle, number of insertions in first fragments, number of insertions in last fragments, number of deletions in first fragments, and number of deletions in last fragments.

COV reports a distribution of the alignment depth per covered reference site. For example an average depth of 50 would ideally result in a normal distribution centred on 50, but the presence of repeats or copy-number variation may reveal multiple peaks at approximate multiples of 50. The first column is an inclusive coverage range in the form of [min-max]. The next columns are a repeat of the maximum portion of the depth range (now as a single integer) and the frequency that depth range was observed. The minimum, maximum and range step size are controlled by the -c option. Depths above and below the minimum and maximum are reported with ranges [<min ] and [max<].

GCD reports the GC content of the reference data aligned against per alignment record, with one row per observed GC percentage reported as the first column and sorted on this column. The second column is a total sequence percentile, as a running total (ending at 100%). The first and second columns may be used to produce a simple distribution of GC content. Subsequent columns list the coverage depth at 10th, 25th, 50th, 75th and 90th GC percentiles for this specific GC percentage, revealing any GC bias in mapping. These columns are averaged depths, so are floating point with no maximum value.

OPTIONS

-c, --coverage MIN,MAX,STEP

Set coverage distribution to the specified range (MIN, MAX, STEP all given as integers) [1,1000,1]

-d, --remove-dups

Exclude from statistics reads marked as duplicates

-f, --required-flag STR|INT

Required flag, 0 for unset. See also `samtools flags` [0]

-F, --filtering-flag STR|INT

Filtering flag, 0 for unset. See also `samtools flags` [0]

--GC-depth FLOAT

the size of GC-depth bins (decreasing bin size increases memory requirement) [2e4]

-h, --help

This help message

-i, --insert-size INT

Maximum insert size [8000]

-I, --id STR

Include only listed read group or sample name []

-l, --read-length INT

Include in the statistics only reads with the given read length [-1]

-m, --most-inserts FLOAT

Report only the main part of inserts [0.99]

-P, --split-prefix STR

A path or string prefix to prepend to filenames output when creating categorised statistics files with -S/--split. [input filename]

-q, --trim-quality INT

The BWA trimming parameter [0]

-r, --ref-seq FILE

Reference sequence (required for GC-depth and mismatches-per-cycle calculation). []

-S, --split TAG

In addition to the complete statistics, also output categorised statistics based on the tagged field TAG (e.g., use --split RG to split into read groups).

Categorised statistics are written to files named <prefix>_<value>.bamstat, where prefix is as given by --split-prefix (or the input filename by default) and value has been encountered as the specified tagged field's value in one or more alignment records.

-t, --target-regions FILE

Do stats in these regions only. Tab-delimited file chr,from,to, 1-based, inclusive. []

-x, --sparse

Suppress outputting IS rows where there are no insertions.

-p, --remove-overlaps

Remove overlaps of paired-end reads from coverage and base count computations.

-g, --cov-threshold INT

Only bases with coverage above this value will be included in the target percentage computation [0]

-X

If this option is set, it will allows user to specify customized index file location(s) if the data folder does not contain any index file. Example usage: samtools stats [options] -X /data_folder/data.bam /index_folder/data.bai chrM:1-10

-@, --threads INT

Number of input/output compression threads to use in addition to main thread [0].

AUTHOR

SEE ALSO

Samtools website: <http://www.htslib.org/>