annotate vcffilter.xml @ 3:0e7ec249e679 draft default tip

Uploaded
author anton
date Mon, 15 Sep 2014 14:51:08 -0400
parents a1c14d64b003
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
1 <tool id="vcffilter2" name="VCFfilter:" version="0.0.2">
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
3 <requirement type="package" version="8a5602bf07">vcflib</requirement>
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
4 </requirements>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
5 <description>filter VCF data in a variety of attributes</description>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
6 <command>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
7 <!-- This tools depends on tabix functionality, which is currently distributed with Galaxy itself via a pysam egg -->
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
8 ln -s "${input1}" input1.vcf.gz &amp;&amp;
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
9 ln -s "${Tabixized_input}" input1.vcf.gz.tbi &amp;&amp;
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
10 vcffilter ${filterList} input1.vcf.gz > "${out_file1}"
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
11 </command>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
12
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
13 <inputs>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
14 <param name="filterList" size="40" type="text" value="-f &quot;DP &gt; 10&quot;" label="Specify filterting expression" help="See explanation of filtering options below">
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
15 <sanitizer>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
16 <valid initial="string.printable">
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
17 <remove value="&apos;"/>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
18 </valid>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
19 <mapping initial="none">
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
20 <add source="&apos;" target="__sq__"/>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
21 </mapping>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
22 </sanitizer>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
23 </param>
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
24 <param format="vcf_bgzip" name="input1" type="data" label="VCF dataset to filter">
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
25 <conversion name="Tabixized_input" type="tabix" />
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
26 </param>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
27 </inputs>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
28 <outputs>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
29 <data format="vcf" name="out_file1" />
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
30 </outputs>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
31 <tests>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
32 <test>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
33 <param name="filterList" value="-f &quot;DP &gt; 10&quot;"/>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
34 <param name="input1" value="vcflib.vcf"/>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
35 <output name="out_file1" file="vcffilter-test1.vcf"/>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
36 </test>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
37 </tests>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
38 <help>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
39
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
40 You can specify the following options within the **Specify filtering expression** box in any combination::
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
41
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
42 -f, --info-filter specifies a filter to apply to the info fields of records, removes alleles which do not pass the filter
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
43 -g, --genotype-filter specifies a filter to apply to the genotype fields of records
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
44 -s, --filter-sites filter entire records, not just alleles
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
45 -t, --tag-pass tag vcf records as positively filtered with this tag, print all records
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
46 -F, --tag-fail tag vcf records as negatively filtered with this tag, print all records
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
47 -A, --append-filter append the existing filter tag, don't just replace it
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
48 -a, --allele-tag apply -t on a per-allele basis. adds or sets the corresponding INFO field tag
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
49 -v, --invert inverts the filter, e.g. grep -v
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
50 -o, --or use logical OR instead of AND to combine filters
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
51 -r, --region specify a region on which to target the filtering (must be used in conjunction with -f or -g)
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
52
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
53 Filters are specified in the form {ID} {operator} {value}::
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
54
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
55 -f "DP > 10" # for info fields
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
56 -g "GT = 1|1" # for genotype fields
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
57 -f "CpG" # for 'flag' fields
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
58
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
59 Any number of filters may be specified. They are combined via logical AND unless the --or option is specified. For convenience, you can specify "QUAL" to refer to the quality of the site, even though it does not appear in the INFO fields.
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
60
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
61 Operators can be any of: =, !, &lt;, &gt;, pipe, &amp;
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
62
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
63
3
0e7ec249e679 Uploaded
anton
parents: 2
diff changeset
64 To restrict output to a specific location use the -r option (must be used in conjunction with -g or -f)::
0
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
65
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
66 -r chr20:14000-15000 # only output calls between positions 14,000 and 15,000 on chromosome 20
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
67 -r chrX # only output call on chromosome X
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
68
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
69 -----
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
70
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
71 Vcffilter is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
72
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
73 </help>
f84ad3b2d320 Imported from capsule None
anton
parents:
diff changeset
74 </tool>