annotate filter_vcf.xml @ 18:ec61f77332ff draft default tip

Uploaded
author ulfschaefer
date Tue, 10 May 2016 09:06:04 -0400
parents 10dca609454e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
1 <tool id="filter_vcf" name="Filter VCF" version="1.0">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
2 <description>filters a VCF file</description>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
3 <requirements>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
4 <requirement type="package" version="2.7.10">python</requirement>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
5 <requirement type="package" version="0.6.8dev">pyvcf</requirement>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
6 <requirement type="package" version="3.11">pyyaml</requirement>
3
1368dc1867f7 Uploaded
ulfschaefer
parents: 0
diff changeset
7 <requirement type="package" version="2.0.2">bintrees</requirement>
1368dc1867f7 Uploaded
ulfschaefer
parents: 0
diff changeset
8 <requirement type="package" version="1.66">biopython</requirement>
1368dc1867f7 Uploaded
ulfschaefer
parents: 0
diff changeset
9 <requirement type="package" version="1.4">matplotlib</requirement>
9
b89b567f33f7 Uploaded
ulfschaefer
parents: 3
diff changeset
10 <requirement type="package" version="0.23.1">cython</requirement>
3
1368dc1867f7 Uploaded
ulfschaefer
parents: 0
diff changeset
11 <requirement type="package" version="1.0">phephenix</requirement>
0
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
12 </requirements>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
13 <stdio>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
14 <!-- Assume anything other than zero is an error -->
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
15 <exit_code range="1:" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
16 <exit_code range=":-1" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
17 </stdio>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
18 <command interpreter="bash">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
19 filter_vcf.sh
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
20 $output
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
21 $input
17
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
22 #if str($onlygood) == "false":
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
23 onlygood
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
24 #else
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
25 NOTTHERE
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
26 #end if
0
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
27 #for $sf in $snp_filter:
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
28 #for $name, $param in $sf.snp_filter_type.iteritems():
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
29 #if $name not in [ "__current_case__", "snp_filter_type_selector" ]:
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
30 ${name}:"${param}"
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
31 #end if
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
32 #end for
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
33 #end for
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
34 </command>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
35
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
36 <inputs>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
37 <param name="input" type="data" format="vcf" label="VCF File to filter" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
38
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
39 <repeat name="snp_filter" title="SNP Filter" help="">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
40 <conditional name="snp_filter_type">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
41 <param name="snp_filter_type_selector" type="select" label="SNP Filter Type">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
42 <option value="gq_score_option">GQ score</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
43 <option value="dp4_ratio_option">DP4 ratio</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
44 <option value="ad_ratio_option">AD ratio</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
45 <option value="mq_score_option">MQ score</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
46 <option value="min_depth_option">Minimum depth</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
47 <option value="uncall_gt_option">Uncall GT</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
48 <option value="mq0_ratio_option">MQ0 ratio</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
49 <option value="qual_score_option">Quality score</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
50 <option value="mq0f_ratio_option">MQ0F ratio</option>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
51 </param>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
52 <when value="gq_score_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
53 <param name="gq_score" type="integer" value="0" label="Minimum GC score" help="Type integer"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
54 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
55 <when value="dp4_ratio_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
56 <param name="dp4_ratio" type="float" value="0.9" label="Minimum DP4 ratio" help="Type float"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
57 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
58 <when value="ad_ratio_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
59 <param name="ad_ratio" type="float" value="0.9" label="Minimum AD ratio" help="Type float"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
60 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
61 <when value="mq_score_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
62 <param name="mq_score" type="integer" value="30" label="Minimum MQ score" help="Type integer"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
63 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
64 <when value="min_depth_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
65 <param name="min_depth" type="integer" value="5" label="Minimum depth" help="Type integer"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
66 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
67 <when value="uncall_gt_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
68 <param name="uncall_gt" type="text" value="" hidden="True"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
69 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
70 <when value="mq0_ratio_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
71 <param name="mq0_ratio" type="float" value="0.05" label="Minimim MQ0 ratio" help="Type float"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
72 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
73 <when value="qual_score_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
74 <param name="qual_score" type="integer" value="30" label="Minimim quality score" help="Type integer"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
75 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
76 <when value="mq0f_ratio_option">
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
77 <param name="mq0f_ratio" type="float" value="0.05" label="Minimum MQ0F ratio" help="Type float"/>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
78 </when>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
79 </conditional>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
80 </repeat>
17
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
81 <param name="onlygood" type="select" label="Write only good variants to output" help="Write only variants that PASS all filters. ">
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
82 <option value="true" selected="true">Write all</option>
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
83 <option value="false">Write only good</option>
10dca609454e Uploaded
ulfschaefer
parents: 9
diff changeset
84 </param>
0
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
85 </inputs>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
86
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
87 <outputs>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
88 <data format="vcf" name="output" label="${tool.name} on ${on_string}: filtered VCF" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
89 </outputs>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
90 <tests>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
91 <test>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
92 <param name="input" value="test_input.vcf" ftype="vcf" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
93 <param name="min_depth" value="100" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
94 <output name="output" file="test_output.vcf" ftype="vcf" />
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
95 </test>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
96 </tests>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
97 <help>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
98
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
99 usage: filter_vcf.py [-h] \-\-vcf VCF \-\-filters FILTERS \-\-output OUTPUT
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
100
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
101 optional arguments:
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
102
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
103 -h, \-\-help show this help message and exit
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
104
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
105 \-\-vcf VCF, -v VCF VCF file to (re)filter.
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
106
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
107 \-\-filters FILTERS, -f FILTERS Filter(s) to apply as key:threshold pairs, separated by comma.
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
108
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
109 \-\-output OUTPUT, -o OUTPUT Location for filtered VCF to be written.
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
110
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
111 </help>
45ff0fc972e8 Uploaded
ulfschaefer
parents:
diff changeset
112 </tool>