ReadClippingStats

Collect read clipping statistics

Category Diagnostics and Quality Control Tools

Traversal ReadWalker

PartitionBy READ


Overview

This tool collects statistics about the read length, number of clipping events, and length of the clipping in all reads in the dataset.

Input

One or more BAM files.

Output

A simple tabulated text file with read length and clipping statistics for every read (or every given number of reads if the "skip" option is used).

Caveat

This tool ignores "N" events in the CIGAR string.


Additional Information

Read filters

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

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.

ReadClippingStats 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
Optional Flags
--include_unmapped
 -u
false Include unmapped reads in the analysis
Advanced Parameters
--skip
1 Do not print all reads, skip some.

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.


--include_unmapped / -u

Include unmapped reads in the analysis
when this flag is set (default), statistics will be collected on unmapped reads as well. The default behavior is to ignore unmapped reads."

boolean  false


--out / -o

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

PrintStream  stdout


--skip / -skip

Do not print all reads, skip some.
print every read whose read number is divisible by SKIP. READ_NUMBER % SKIP == 0. First read in the file has read number = 1, second is 2, third is 3, ... A value of 1 means print every read. A value of 1000 means print every 1000th read.

int  1  [ [ -∞  ∞ ] ]


Return to top


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

GATK version 3.8-0-ge9d806836 built at 2017/07/29 01:40:22.