|
0
|
1 <tool id="vcf_filter" name="VCF Filter">
|
|
|
2 <description>Extracts lines from a vcf variant file based on field-specific filters</description>
|
|
2
|
3 <macros>
|
|
|
4 <import>toolshed_macros.xml</import>
|
|
|
5 </macros>
|
|
|
6 <expand macro="requirements"/>
|
|
0
|
7 <version_command>mimodd version -q</version_command>
|
|
|
8 <command>
|
|
|
9 mimodd vcf-filter
|
|
|
10 "$inputfile"
|
|
|
11 -o "$outputfile"
|
|
|
12 #if len($datasets):
|
|
|
13 -s
|
|
|
14 #for $i in $datasets
|
|
|
15 "$i.sample"
|
|
|
16 #end for
|
|
|
17 --gt
|
|
|
18 #for $i in $datasets
|
|
|
19 ## remove whitespace from free-text input
|
|
|
20 "#echo ("".join($i.GT.split()) or "ANY")#"
|
|
|
21 #echo " "
|
|
|
22 #end for
|
|
|
23 --dp
|
|
|
24 #for $i in $datasets
|
|
|
25 "$i.DP"
|
|
|
26 #end for
|
|
|
27 --gq
|
|
|
28 #for $i in $datasets
|
|
|
29 "$i.GQ"
|
|
|
30 #end for
|
|
|
31 #end if
|
|
|
32 #if len($regions):
|
|
|
33 -r
|
|
|
34 #for $i in $regions
|
|
|
35 #if $i.stop:
|
|
|
36 "$i.chrom:$i.start-$i.stop"
|
|
|
37 #else:
|
|
|
38 "$i.chrom:$i.start"
|
|
|
39 #end if
|
|
|
40 #end for
|
|
|
41 #end if
|
|
|
42 #if $vfilter:
|
|
|
43 --vfilter
|
|
|
44 ## remove ',' (and possibly adjacent whitespace) and replace with ' '
|
|
|
45 "#echo ('" "'.join($vfilter.split(',')))#"
|
|
|
46 #end if
|
|
|
47 $vartype
|
|
|
48 </command>
|
|
|
49
|
|
|
50 <inputs>
|
|
|
51 <param name="inputfile" type="data" format="vcf" label="VCF input file" />
|
|
|
52 <repeat name="datasets" title="Sample-specific Filter" default="0" min="0">
|
|
|
53 <param name="sample" type="text" label="sample" help="name of a sample as it appears in the VCF input file and that indicates the sample that this filter should be applied to." />
|
|
|
54 <param name="GT" type="text" label="genotype pattern(s) for the inclusion of variants" help="keep only variants for which the genotype of the sample matches the specified pattern; format: x/x where x = 0 is wildtype and x = 1 is mutant. Multiple genotypes can be specified as a comma-separated list." />
|
|
|
55 <param name="DP" type="integer" label="depth of coverage for the sample at the variant site" value = "0" help="keep only variants with at least this sample-specific coverage at the variant site" />
|
|
|
56 <param name="GQ" type="integer" label="genotype quality for the variant in the sample" value = "0" help="keep only variants for which the genotype prediction for the sample has at least this quality" />
|
|
|
57 </repeat>
|
|
|
58 <repeat name="regions" title="Region Filter" default="0" min="0" help = "Filter variant sites by their position in the genome. If multiple Region Filters are specified, all variants that fall in ONE of the regions are reported.">
|
|
|
59 <param name="chrom" type="text" label="Chromosome" />
|
|
|
60 <param name="start" type="text" label="Region Start" />
|
|
|
61 <param name="stop" type="text" label="Region End" />
|
|
|
62 </repeat>
|
|
|
63 <param name="vartype" type="select" label="Select the types of variants to include in the output">
|
|
|
64 <option value="">all types of variants</option>
|
|
|
65 <option value="--no-indels">exclude indels</option>
|
|
|
66 <option value="--indels-only">only indels</option>
|
|
|
67 </param>
|
|
|
68 <param name="vfilter" type="text" label="sample" help="Filter output by sample name; only the sample-specific columns with their sample name matching any of the comma separated filters will be retained in the output." />
|
|
|
69 </inputs>
|
|
|
70
|
|
|
71 <outputs>
|
|
|
72 <data name="outputfile" format="vcf" />
|
|
|
73 </outputs>
|
|
|
74
|
|
|
75 <help>
|
|
|
76 .. class:: infomark
|
|
|
77
|
|
|
78 **What it does**
|
|
|
79
|
|
|
80 The tool filters a variant file in VCF format to generate a new VCF file with only a subset of the original variants.
|
|
|
81
|
|
|
82 The following types of variant filters can be set up:
|
|
|
83
|
|
|
84 1) Sample-specific filters:
|
|
|
85
|
|
|
86 Filter variants based on their characteristics in the sequenced reads of a specific sample. Multiple sample-specific filters are combined by logical AND, i.e., only variants that pass ALL sample-specific filters are kept.
|
|
|
87
|
|
|
88 2) Region filters:
|
|
|
89
|
|
|
90 Filter variants based on the genomic region they affect. Multiple region filters are combined by logical OR, i.e., variants passing ANY region filter are kept.
|
|
|
91
|
|
|
92 3) Variant type filter:
|
|
|
93
|
|
|
94 Filter variants by their type, i.e. whether they are single nucleotide variations (SNVs) or indels
|
|
|
95
|
|
|
96 In addition, the *sample* filter can be used to reduce the samples encoded in a multi-sample VCF file to just those specified by the filter.
|
|
|
97 The *sample* filter is included mainly for compatibility reasons: if an external tool cannot deal with the multisample file format, but instead looks only at the first sample-specific column of the file, you can use the filter to turn the multi-sample file into a single-sample file. Besides, the filter can also be used to change the order of the samples since it will sort the samples in the order specified in the filter field.
|
|
|
98
|
|
|
99 **Examples of sample-specific filters:**
|
|
|
100
|
|
|
101 *Simple genotype pattern*
|
|
|
102
|
|
|
103 genotype pattern: 1/1 ==> keep all variants in the vcf input file for which the specified sample's genotype is homozygous mutant
|
|
|
104
|
|
|
105 *Complex genotype pattern*
|
|
|
106
|
|
|
107 genotype pattern: 0/1, 0/0 ==> keep all variants for which the sample's genotype is either heterozygous or homozygous wildtype
|
|
|
108
|
|
|
109 *Multiple sample-specific filters*
|
|
|
110
|
|
|
111 Filter 1: genotype pattern: 0/0, Filter 2: genotype pattern 1/1:
|
|
|
112 ==> keep all variants for which the first sample's gentoype is homozygous wildtype **and** the second sample's genotype is homozygous mutant
|
|
|
113
|
|
|
114 *Combining sample-specific filter criteria*
|
|
|
115
|
|
|
116 genotype pattern: 1/1, depth of coverage: 3, genotype quality: 9
|
|
|
117 ==> keep variants for which the sample's genotype is homozygous mutant **and** for which this genotype assignment is corroborated by a genotype quality score of at least 9
|
|
|
118 **and** at least three reads from the sample cover the variant site
|
|
|
119
|
|
|
120 **TIP:**
|
|
|
121
|
|
|
122 As in the example above, genotype quality is typically most useful in combination with a genotype pattern.
|
|
|
123 It acts then, effectively, to make the genotype filter more stringent.
|
|
|
124
|
|
|
125
|
|
|
126
|
|
|
127 </help>
|
|
|
128 </tool>
|
