Documentation

Pileup

Emulates the samtools pileup command to print aligned reads

Category Diagnostics and Quality Control Tools

Traversal LocusWalker

PartitionBy LOCUS


Overview

Prints the alignment in something similar to the Samtools pileup format (see the Pileup format documentation for more details about the original format). There is one line per genomic position, listing the chromosome name, coordinate, reference base, read bases, and read qualities. In addition to these default fields, additional information can be added to the output as extra columns; see options detailed below.

Emulated command:

  samtools pileup -f in.ref.fasta -l in.site_list input.bam
 

Input

A BAM file and the interval to print.

Output

Alignment of reads formatted in the Pileup style.

Example

 java -Xmx2g -jar GenomeAnalysisTK.jar \
   -T Pileup \
   -R exampleFASTA.fasta \
   -I exampleBAM.bam \
   -L chr1:257-267
   -o output.txt
 

Expected output

     chr1 257 A CAA '&=
     chr1 258 C TCC A:=
     chr1 259 C CCC )A=
     chr1 260 C ACC (=<
     chr1 261 T TCT '44
     chr1 262 A AAA '?:
     chr1 263 A AGA 1'6
     chr1 264 C TCC 987
     chr1 265 C CCC (@(
     chr1 266 C GCC ''=
     chr1 267 T AAT 7%>
 

Additional Information

Read filters

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

Parallelism options

This tool can be run in multi-threaded mode using these options.

Downsampling settings

This tool applies the following downsampling settings by default.

  • Mode: BY_SAMPLE
  • To coverage: 1,000

Command-line Arguments

Inherited arguments

The arguments described in the entries below can be supplied to this tool to modify its behavior. For example, the -L argument directs the GATK engine restricts processing to specific genomic intervals (this is an Engine capability and is therefore available to all GATK walkers).

Pileup 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 Inputs
--metadata
[] ROD file containing metadata
Optional Outputs
--out
 -o
stdout An output file created by the walker. Will overwrite contents if file exists
Optional Flags
--showVerbose
 -verbose
false Add an extra verbose section to the pileup output

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.


--metadata / -metadata

ROD file containing metadata
This enables annotating the pileup to show overlaps with metadata from a ROD file. For example, if you provide a VCF and there is a SNP at a given location covered by the pileup, the pileup output at that position will be annotated with the corresponding source ROD identifier.

--metadata binds reference ordered data. This argument supports ROD files of the following types: BCF2, BEAGLE, BED, BEDTABLE, EXAMPLEBINARY, GELITEXT, OLDDBSNP, RAWHAPMAP, REFSEQ, SAMPILEUP, SAMREAD, TABLE, VCF, VCF3

List[RodBinding[Feature]]  []


--out / -o

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

PrintStream  stdout


--showVerbose / -verbose

Add an extra verbose section to the pileup output
In addition to the standard pileup output, adds 'verbose' output too. The verbose output contains the number of spanning deletions, and for each read in the pileup it has the read name, offset in the base string, read length, and read mapping quality. These per read items are delimited with an '@' character.

boolean  false


See also Guide Index | Tool Documentation Index | Support Forum

GATK version 3.2-2-gec30cee built at 2014/07/17 17:54:48. GTD: NA