Mercurial > repos > devteam > vcffilter

annotate vcffilter.xml @ 3:952059348a30 draft

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