annotate vcffilter.xml @ 0:c56b2e440fce draft

Uploaded
author anton
date Mon, 14 Apr 2014 10:06:14 -0400
parents
children e5dd21db760b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c56b2e440fce Uploaded
anton
parents:
diff changeset
1 <tool id="vcffilter" name="VCFfilter:" version="0.0.1">
c56b2e440fce Uploaded
anton
parents:
diff changeset
2 <requirements>
c56b2e440fce Uploaded
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
c56b2e440fce Uploaded
anton
parents:
diff changeset
4 </requirements>
c56b2e440fce Uploaded
anton
parents:
diff changeset
5 <description>filter VCF data in a variety of attributes</description>
c56b2e440fce Uploaded
anton
parents:
diff changeset
6 <command>vcffilter ${filterList} "${input}" > "${out_file1}"</command>
c56b2e440fce Uploaded
anton
parents:
diff changeset
7 <inputs>
c56b2e440fce Uploaded
anton
parents:
diff changeset
8 <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">
c56b2e440fce Uploaded
anton
parents:
diff changeset
9 <sanitizer>
c56b2e440fce Uploaded
anton
parents:
diff changeset
10 <valid initial="string.printable">
c56b2e440fce Uploaded
anton
parents:
diff changeset
11 <remove value="&apos;"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
12 </valid>
c56b2e440fce Uploaded
anton
parents:
diff changeset
13 <mapping initial="none">
c56b2e440fce Uploaded
anton
parents:
diff changeset
14 <add source="&apos;" target="__sq__"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
15 </mapping>
c56b2e440fce Uploaded
anton
parents:
diff changeset
16 </sanitizer>
c56b2e440fce Uploaded
anton
parents:
diff changeset
17 </param>
c56b2e440fce Uploaded
anton
parents:
diff changeset
18 <param format="vcf" name="input" type="data" label="From"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
19 </inputs>
c56b2e440fce Uploaded
anton
parents:
diff changeset
20 <outputs>
c56b2e440fce Uploaded
anton
parents:
diff changeset
21 <data format="vcf" name="out_file1" />
c56b2e440fce Uploaded
anton
parents:
diff changeset
22 </outputs>
c56b2e440fce Uploaded
anton
parents:
diff changeset
23 <tests>
c56b2e440fce Uploaded
anton
parents:
diff changeset
24 <test>
c56b2e440fce Uploaded
anton
parents:
diff changeset
25 <param name="filterList" value="-f &quot;DP &gt; 10&quot;"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
26 <param name="input" value="vcflib.vcf"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
27 <output name="out_file1" file="vcffilter-test1.vcf"/>
c56b2e440fce Uploaded
anton
parents:
diff changeset
28 </test>
c56b2e440fce Uploaded
anton
parents:
diff changeset
29 </tests>
c56b2e440fce Uploaded
anton
parents:
diff changeset
30 <help>
c56b2e440fce Uploaded
anton
parents:
diff changeset
31
c56b2e440fce Uploaded
anton
parents:
diff changeset
32 VCFfilter is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
c56b2e440fce Uploaded
anton
parents:
diff changeset
33
c56b2e440fce Uploaded
anton
parents:
diff changeset
34 You can specify the following option the **Specify filtering expression** box in any combination::
c56b2e440fce Uploaded
anton
parents:
diff changeset
35
c56b2e440fce Uploaded
anton
parents:
diff changeset
36 -f, --info-filter specifies a filter to apply to the info fields of records, removes alleles which do not pass the filter
c56b2e440fce Uploaded
anton
parents:
diff changeset
37 -g, --genotype-filter specifies a filter to apply to the genotype fields of records
c56b2e440fce Uploaded
anton
parents:
diff changeset
38 -s, --filter-sites filter entire records, not just alleles
c56b2e440fce Uploaded
anton
parents:
diff changeset
39 -t, --tag-pass tag vcf records as positively filtered with this tag, print all records
c56b2e440fce Uploaded
anton
parents:
diff changeset
40 -F, --tag-fail tag vcf records as negatively filtered with this tag, print all records
c56b2e440fce Uploaded
anton
parents:
diff changeset
41 -A, --append-filter append the existing filter tag, don't just replace it
c56b2e440fce Uploaded
anton
parents:
diff changeset
42 -a, --allele-tag apply -t on a per-allele basis. adds or sets the corresponding INFO field tag
c56b2e440fce Uploaded
anton
parents:
diff changeset
43 -v, --invert inverts the filter, e.g. grep -v
c56b2e440fce Uploaded
anton
parents:
diff changeset
44 -o, --or use logical OR instead of AND to combine filters
c56b2e440fce Uploaded
anton
parents:
diff changeset
45
c56b2e440fce Uploaded
anton
parents:
diff changeset
46 Filters are specified in the form {ID} {operator} {value}::
c56b2e440fce Uploaded
anton
parents:
diff changeset
47
c56b2e440fce Uploaded
anton
parents:
diff changeset
48 -f "DP > 10" # for info fields
c56b2e440fce Uploaded
anton
parents:
diff changeset
49 -g "GT = 1|1" # for genotype fields
c56b2e440fce Uploaded
anton
parents:
diff changeset
50 -f "CpG" # for 'flag' fields
c56b2e440fce Uploaded
anton
parents:
diff changeset
51
c56b2e440fce Uploaded
anton
parents:
diff changeset
52 Operators can be any of: =, !, &lt;, &gt;, pipe, &amp;
c56b2e440fce Uploaded
anton
parents:
diff changeset
53
c56b2e440fce Uploaded
anton
parents:
diff changeset
54 Any number of filters may be specified. They are combined via logical AND
c56b2e440fce Uploaded
anton
parents:
diff changeset
55 unless --or is specified on the command line.
c56b2e440fce Uploaded
anton
parents:
diff changeset
56
c56b2e440fce Uploaded
anton
parents:
diff changeset
57 For convenience, you can specify "QUAL" to refer to the quality of the site, even
c56b2e440fce Uploaded
anton
parents:
diff changeset
58 though it does not appear in the INFO fields.
c56b2e440fce Uploaded
anton
parents:
diff changeset
59
c56b2e440fce Uploaded
anton
parents:
diff changeset
60 </help>
c56b2e440fce Uploaded
anton
parents:
diff changeset
61 </tool>