annotate tools/vcf_tools/filter.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="vcf_filter" name="Filter" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>a VCF file</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 vcfPytools.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 filter
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 --in=$input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 --out=$output1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 --quality=$quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 #for $i in $info_filter:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 --info ${i.info}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 #end for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 $remove_genotypes
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 $mark_as_pass
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <param name="input1" label="VCF file" type="data" format="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <param name="quality" label="Filter by quality" type="integer" value='' help="Filter out SNPs with qualities lower than selected value" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <repeat name="info_filter" title="Filter based on entries in the info string">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <param name="info" label="Filter" type="text" value='' help='This option takes three values: the info string tag, the cutoff value and whether to filter out those records with less than (lt) or greater than (gt) this value. For example: DP 10 lt ' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 </repeat>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <param name="remove_genotypes" label="Remove the genotype strings" type="boolean" truevalue="--remove-genotypes" falsevalue="" checked="False" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="mark_as_pass" label="Mark all records as having passed filters" type="boolean" truevalue="--mark-as-pass" falsevalue="" checked="False" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <param name="input1" value="test.small.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name="quality" value="9" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name="info" value="NS 360 gt"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="remove_genotypes" value="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="mark_as_pass" value="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <output name="output" file="test_filter_quality_9_NS_360_gt.vcf" lines_diff="6" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <param name="input1" value="test.small.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <param name="quality" value="9" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <param name="info" value="DP 2000 lt"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <param name="remove_genotypes" value="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <param name="mark_as_pass" value="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <output name="output" file="test_filter_quality_9_DP_2000_lt.vcf" lines_diff="6" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <data format="vcf" name="output1" label="${tool.name} ${on_string}" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 This tool uses vcfPytools_' filter command
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 .. _vcfPytools: https://github.com/AlistairNWard/vcfPytools
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 Quality option will check the variant quality for each record and if it is below the defined value, the filter field will be populated with the filter entry Q[value].
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 Any value in the info string can be used for filtering by using the 'Filter by info' option. This option takes three values: the info string tag, the cutoff value and whether to filter out those records with less than (lt) or greater than (gt) this value. For example:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 DP 10 lt
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 would filter out all varianta with a depth (DP) less than 10 and the filter field would be populated with DP10.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 This option can be defined as many times as required.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 </tool>