annotate vcffilter.xml @ 0:34c3b846e0b6 draft

Uploaded
author devteam
date Thu, 19 Mar 2015 14:27:51 -0400
parents
children e729e584cd6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
1 <tool id="vcffilter2" name="VCFfilter:" version="0.0.3">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
2 <description>filter VCF data in a variety of attributes</description>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
3 <macros>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
4 <import>macros.xml</import>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
5 </macros>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
6 <expand macro="requirements">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
7 <requirement type="package" version="0.2.6">tabix</requirement>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
8 </expand>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
9 <expand macro="stdio" />
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
10 <command>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
11 <!-- This tools depends on tabix functionality, which is currently distributed with Galaxy itself via a pysam egg -->
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
12 ln -s "${input1}" input1.vcf &amp;&amp;
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
13 bgzip input1.vcf &amp;&amp;
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
14 tabix -p vcf input1.vcf.gz &amp;&amp;
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
15 vcffilter ${filterList} input1.vcf.gz > "${out_file1}"
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
16 </command>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
17
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
18 <inputs>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
19 <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">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
20 <sanitizer>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
21 <valid initial="string.printable">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
22 <remove value="&apos;"/>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
23 </valid>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
24 <mapping initial="none">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
25 <add source="&apos;" target="__sq__"/>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
26 </mapping>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
27 </sanitizer>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
28 </param>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
29 <param format="vcf" name="input1" type="data" label="VCF dataset to filter">
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
30 </param>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
31 </inputs>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
32 <outputs>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
33 <data format="vcf" name="out_file1" />
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
34 </outputs>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
35 <tests>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
36 <test>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
37 <param name="filterList" value="-f &quot;DP &gt; 10&quot;"/>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
38 <param name="input1" value="vcflib.vcf"/>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
39 <output name="out_file1" file="vcffilter-test1.vcf"/>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
40 </test>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
41 </tests>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
42 <help>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
43
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
44 You can specify the following options within the **Specify filtering expression** box in any combination::
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
45
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
46 -f, --info-filter specifies a filter to apply to the info fields of records, removes alleles which do not pass the filter
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
47 -g, --genotype-filter specifies a filter to apply to the genotype fields of records
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
48 -s, --filter-sites filter entire records, not just alleles
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
49 -t, --tag-pass tag vcf records as positively filtered with this tag, print all records
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
50 -F, --tag-fail tag vcf records as negatively filtered with this tag, print all records
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
51 -A, --append-filter append the existing filter tag, don't just replace it
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
52 -a, --allele-tag apply -t on a per-allele basis. adds or sets the corresponding INFO field tag
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
53 -v, --invert inverts the filter, e.g. grep -v
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
54 -o, --or use logical OR instead of AND to combine filters
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
55 -r, --region specify a region on which to target the filtering (must be used in conjunction with -f or -g)
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
56
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
57 Filters are specified in the form {ID} {operator} {value}::
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
58
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
59 -f "DP > 10" # for info fields
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
60 -g "GT = 1|1" # for genotype fields
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
61 -f "CpG" # for 'flag' fields
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
62
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
63 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.
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
64
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
65 Operators can be any of: =, !, &lt;, &gt;, pipe, &amp;
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
66
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
67
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
68 To restrict output to a specific location use the -r option (must be used in conjunction with -g or -f)::
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
69
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
70 -r chr20:14000-15000 # only output calls between positions 14,000 and 15,000 on chromosome 20
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
71 -r chrX # only output call on chromosome X
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
72
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
73 -----
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
74
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
75 Vcffilter @IS_PART_OF_VCFLIB@
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
76 </help>
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
77 <expand macro="citations" />
34c3b846e0b6 Uploaded
devteam
parents:
diff changeset
78 </tool>