Documentation

SelectHeaders

Selects headers from a VCF source.

Category Variant Evaluation and Manipulation Tools

Traversal LocusWalker

PartitionBy LOCUS


Overview

Often, a VCF containing many headers will need to be subset in order to facilitate certain formatting guidelines. SelectHeaders can be used for this purpose. Given a single VCF file, one or more headers can be extracted from the file (based on a complete header name or a pattern match).

Input

A set of VCFs.

Output

A header selected VCF.

Examples

 Select only the FILTER, FORMAT, and INFO headers:
 java -Xmx2g -jar GenomeAnalysisTK.jar \
   -R ref.fasta \
   -T SelectHeaders \
   --variant input.vcf \
   -o output.vcf \
   -hn FILTER \
   -hn FORMAT \
   -hn INFO

 Select only the FILTER, FORMAT, and INFO headers and add in the reference file names:
 java -Xmx2g -jar GenomeAnalysisTK.jar \
   -R ref.fasta \
   -T SelectHeaders \
   --variant input.vcf \
   -o output.vcf \
   -hn FILTER \
   -hn FORMAT \
   -hn INFO \
   -irn \
   -iln

 Select only the FILTER, FORMAT, and INFO headers, plus any headers with SnpEff:
 java -Xmx2g -jar GenomeAnalysisTK.jar \
   -R ref.fasta \
   -T SelectHeaders \
   --variant input.vcf \
   -o output.vcf \
   -hn FILTER \
   -hn FORMAT \
   -hn INFO \
   -he '.*SnpEff.*'
 

Additional Information

Read filters

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

Parallelism options

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

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).

SelectHeaders 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
Required Inputs
--variant
 -V
NA Input VCF file
Optional Outputs
--out
 -o
stdout File to which variants should be written
Optional Parameters
--exclude_header_name
 -xl_hn
NA Exclude header. Can be specified multiple times
--header_expression
 -he
NA Regular expression to select many headers from the tracks provided. Can be specified multiple times
--header_name
 -hn
NA Include header. Can be specified multiple times
Optional Flags
--include_interval_names
 -iln
false If set the interval file name minus the file extension, or the command line intervals, will be added to the headers

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.


--exclude_header_name / -xl_hn

Exclude header. Can be specified multiple times
Note that header exclusion takes precedence over inclusion, so that if a header is in both lists it will be excluded.

Set[String]


--header_expression / -he

Regular expression to select many headers from the tracks provided. Can be specified multiple times

Set[String]


--header_name / -hn

Include header. Can be specified multiple times

Set[String]


--include_interval_names / -iln

If set the interval file name minus the file extension, or the command line intervals, will be added to the headers
Note that interval name inclusion takes precedence over other header matching. If set other interval lines may be excluded but the intervals will still be added.

boolean  false


--out / -o

File to which variants should be written

VariantContextWriter  stdout


--variant / -V

Input VCF file
Variants from this VCF file are used by this tool as input. The file must at least contain the standard VCF header lines, but can be empty (i.e., no variants are contained in the file).

--variant binds reference ordered data. This argument supports ROD files of the following types: BCF2, VCF, VCF3

R RodBinding[VariantContext]


See also Guide Index | Tool Documentation Index | Support Forum

GATK version 3.1-1-g07a4bf8 built at 2014/03/18 07:00:36. GTD: NA