Showing docs for version 3.6-0 | The latest version is 4.1.4.0


FlagStat

Collect statistics about sequence reads based on their SAM flags

Category Diagnostics and Quality Control Tools

Traversal ReadWalker

PartitionBy READ


Overview

This tool emulates the behavior of 'samtools flagstat'. It collects statistics such as total number of reads, reads with QC failure flag set, number of duplicates, percentage mapped, etc.

Input

A BAM file containing the sequence data.

Output

Resulting stats are written to file if an output file name is given (with -o), otherwise output to stdout.

Usage example

 java -jar GenomeAnalysisTK.jar \
   -T FlagStat \
   -R reference.fasta \
   -I reads.bam \
   [-o output.txt]
 

Additional Information

Read filters

These Read Filters are automatically applied to the data by the Engine before processing by FlagStat.

Parallelism options

This tool can be run in multi-threaded mode using this option.

Downsampling settings

This tool does not apply any downsampling by default.


Command-line Arguments

Engine arguments

All tools inherit arguments from the GATK Engine' "CommandLineGATK" argument collection, which can be used to modify various aspects of the tool's function. For example, the -L argument directs the GATK engine to restrict processing to specific genomic intervals; or the -rf argument allows you to apply certain read filters to exclude some of the data from the analysis.

FlagStat specific arguments

This table summarizes the command-line arguments that are specific to this tool. For more details on each argument, see the list further down below the table or click on an argument name to jump directly to that entry in the list.

Argument name(s) Default value Summary
Optional Outputs
--out
 -o
stdout An output file created by the walker. Will overwrite contents if file exists

Argument details

Arguments in this list are specific to this tool. Keep in mind that other arguments are available that are shared with other tools (e.g. command-line GATK arguments); see Inherited arguments above.


--out / -o

An output file created by the walker. Will overwrite contents if file exists

PrintStream  stdout


Return to top


See also GATK Documentation Index | Tool Docs Index | Support Forum

GATK version 3.6-0-g89b7209 built at 2017/02/09 12:52:48.