Mercurial > repos > iuc > tb_variant_filter

annotate tb_variant_filter.xml @ 1:eee2da03d1f5 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
author iuc
date Sat, 22 May 2021 10:13:18 +0000
parents 3b1e7c170b10
children e5c84ba20d99
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
1 <tool id="tb_variant_filter" name="TB Variant Filter" version="@TOOL_VERSION@+galaxy0" profile="21.01">
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
2 <description>M. tuberculosis H37Rv VCF filter</description>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
3 <macros>
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
4 <token name="@TOOL_VERSION@">0.3.0</token>
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
5 </macros>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
6 <requirements>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">tb_variant_filter</requirement>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
8 </requirements>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
10 tb_variant_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
11 #if "region_filter" in str($filters).split(',')
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
12 #if str($filter_options.show_filter_options) == "yes":
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
13 --region_filter $filter_options.region_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
14 #else
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
15 --region_filter pe_ppe,uvp
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
16 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
17 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
18 #if "close_to_indel_filter" in str($filters).split(',')
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
19 --close_to_indel_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
20 #if str($filter_options.show_filter_options) == "yes":
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
21 --indel_window_size $filter_options.indel_window_size
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
22 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
23 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
24 #if "min_percentage_alt_filter" in str($filters).split(',')
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
25 --min_percentage_alt_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
26 #if str($filter_options.show_filter_options) == "yes":
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
27 --min_percentage_alt $filter_options.min_percentage_alt
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
28 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
29 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
30 #if "min_depth_filter" in str($filters).split(',')
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
31 --min_depth_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
32 #if str($filter_options.show_filter_options) == "yes":
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
33 --min_depth $filter_options.min_depth
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
34 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
35 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
36 #if "snv_only_filter" in str($filters).split(','):
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
37 --snv_only_filter
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
38 #end if
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
39 '$input1' '$output1'
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
40 ]]></command>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
41 <inputs>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
42 <param type="data" name="input1" label="VCF file to be filter" format="vcf"/>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
43
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
44 <param type="select" name="filters" multiple="true" label="Filters to apply">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
45 <option value="region_filter" selected="true">Filter out variants by regions</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
46 <option value="close_to_indel_filter">Filter variants close to indels</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
47 <option value="min_percentage_alt_filter">Filter variants by percentage alt allele</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
48 <option value="min_depth_filter">Filter sites by read alignment depth</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
49 <option value="snv_only_filter">Only accept SNVs</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
50 </param>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
51
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
52 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
53 <param type="select" name="show_filter_options" label="Show options for the filters">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
54 <option value="yes">Yes</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
55 <option value="no" selected="true">No</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
56 </param>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
57 <when value="yes">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
58 <param argument="--region_filter" type="select" multiple="true" label="Region filters to enable">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
59 <!-- if these are changed the code above needs to change to keep the defaults in line with those that are default here -->
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
60 <option value="farhat_rlc">Refined Low Confidence regions from Farhat lab</option>
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
61 <option value="pe_ppe" selected="true">PE/PPE</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
62 <option value="tbprofiler">TBProfiler antibiotic resistant genes</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
63 <option value="mtbseq">MTBseq antibiotic resistant genes</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
64 <option value="uvp" selected="true">UVP repeat / insertion sequence sites</option>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
65 </param>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
66 <param argument="--indel_window_size" type="integer" value="5" label="Window to mask around indels"/>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
67 <param argument="--min_percentage_alt" type="float" value="90"
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
68 label="Minimum alternate allele percentage to accept"/>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
69 <param argument="--min_depth" type="integer" value="30" label="Minimum read depth (coverage)"/>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
70 </when>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
71 <when value="no"></when>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
72
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
73 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
74 </inputs>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
75 <outputs>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
76 <data name="output1" format="vcf"/>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
77 </outputs>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
78 <tests>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
79 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
80 <param name="input1" value="test_input1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
81 <param name="filters" value="region_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
82 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
83 <param name="show_filter_options" value="yes" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
84 <param name="region_filter" value="pe_ppe,tbprofiler,uvp" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
85 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
86 <output name="output1" file="test_output1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
87 </test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
88 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
89 <param name="input1" value="test_input1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
90 <param name="filters" value="close_to_indel_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
91 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
92 <param name="show_filter_options" value="yes" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
93 <param name="indel_window_size" value="5" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
94 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
95 <output name="output1" file="test_output2.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
96 </test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
97 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
98 <param name="input1" value="test_input1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
99 <param name="filters" value="min_percentage_alt_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
100 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
101 <param name="show_filter_options" value="yes" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
102 <param name="min_percentage_alt" value="95.0" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
103 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
104 <output name="output1" file="test_output3.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
105 </test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
106 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
107 <param name="input1" value="test_input2.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
108 <param name="filters" value="min_percentage_alt_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
109 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
110 <param name="show_filter_options" value="yes" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
111 <param name="min_percentage_alt" value="30.0" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
112 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
113 <output name="output1" file="test_output4.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
114 </test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
115 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
116 <param name="input1" value="test_input1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
117 <param name="filters" value="min_depth_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
118 <conditional name="filter_options">
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
119 <param name="show_filter_options" value="yes" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
120 <param name="min_depth" value="30" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
121 </conditional>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
122 <output name="output1" file="test_output5.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
123 </test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
124 <test>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
125 <param name="input1" value="test_input1.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
126 <param name="filters" value="snv_only_filter" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
127 <output name="output1" file="test_output6.vcf" ftype="vcf" />
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
128 </test>
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
129 <test>
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
130 <param name="input1" value="test_input1.vcf" ftype="vcf" />
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
131 <param name="filters" value="region_filter" />
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
132 <conditional name="filter_options">
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
133 <param name="show_filter_options" value="yes" />
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
134 <param name="region_filter" value="farhat_rlc" />
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
135 </conditional>
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
136 <assert_stderr>
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
137 <has_text text="masked: 2" />
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
138 </assert_stdout>
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
139 </test>
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
140 </tests>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
141 <help><![CDATA[
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
142 This tool offers multiple options for filtering variants (in
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
143 VCF files, relative to M. tuberculosis H37Rv).
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
144
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
145 It currently has 5 main modes:
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
146
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
147 1. Filter by region. Mask out variants in certain regions. Region lists available as:
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
148 1. Refined Low Confidence (RLC) regions from `Marin et al 2021 <https://www.biorxiv.org/content/10.1101/2021.04.08.438862v1.full>`_
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
149 2. PE/PPE genes from `Fishbein et al 2015 <https://onlinelibrary.wiley.com/doi/full/10.1111/mmi.12981>`_
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
150 3. `TBProfiler <http://tbdr.lshtm.ac.uk/>`_ list of antibiotic resistant genes
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
151 4. `MTBseq <https://github.com/ngs-fzb/MTBseq_source>`_ list of antibiotic resistant genes
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
152 5. `UVP <https://github.com/CPTR-ReSeqTB/UVP>`_ list of repetitive loci in M. tuberculosis genome
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
153 2. Filter by window around indels. Masks out variants within a certain distance (by default 5 bases) of an insertion or deletion site.
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
154 3. Filter by percentage of alternate allele bases. Mask out variants with less than a minimum percentage (by default 90%) alternative alleles.
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
155 4. Filter by depth of aligned reads.
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
156 5. Filter out all variants that are not SNV (single nucleotide variants).
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
157
1
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
158 For region filtering, the default choice is to use the PE/PPE and UVP regions to mask out variants. `Marin et al 2021 <https://www.biorxiv.org/content/10.1101/2021.04.08.438862v1.full>`_
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
159 from Prof Maha Farhat's lab make a persuasive argument that their smaller list of Refined Low Confidence (RLC) regions is a better argument but this work has not yet been peer
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
160 review so it is included as an option that is not currently the default.
eee2da03d1f5 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit ef1b4164979078a6624c5b81fa156755258fb5f8"
iuc
parents: 0
diff changeset
161
0
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
162 When used together the effects of the filters are added (i.e. a variant is masked out if it is masked by any of the filters).
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
163 ]]></help>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
164 <citations>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
165 <citation type="bibtex"><![CDATA[
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
166 @misc{vanHeusden2019,
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
167 author = {van Heusden, P.},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
168 title = {tb_variant_filter},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
169 year = {2019},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
170 publisher = {GitHub},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
171 journal = {GitHub repository},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
172 howpublished = {\url{https://github.com/pvanheus/tb_variant_filter}},
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
173 commit = {4a9b2a4a85ddbfbb0d713a02373c8aa0aa159a6c}
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
174 }
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
175 ]]></citation>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
176 </citations>
3b1e7c170b10 "planemo upload for repository https://github.com/COMBAT-TB/tb_variant_filter commit 36771827ae3d5dc06df488b3faffb392f77e672e"
iuc
parents:
diff changeset
177 </tool>