annotate filter.xml @ 0:da1a6f33b504 draft default tip

Imported from capsule None
author devteam
date Mon, 27 Jan 2014 09:29:09 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="vcf_filter" name="Filter" version="1.0.0">
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
2 <description>a VCF file</description>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
3 <command interpreter="python">
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
4 vcfPytools.py
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
5 filter
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
6 --in=$input1
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
7 --out=$output1
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
8 --quality=$quality
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
9 #for $i in $info_filter:
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
10 --info ${i.info}
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
11 #end for
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
12 $remove_genotypes
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
13 $mark_as_pass
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
14 </command>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
15 <inputs>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
16 <param name="input1" label="VCF file" type="data" format="vcf" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
17 <param name="quality" label="Filter by quality" type="integer" value='' help="Filter out SNPs with qualities lower than selected value" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
18 <repeat name="info_filter" title="Filter based on entries in the info string">
da1a6f33b504 Imported from capsule None
devteam
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 ' />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
20 </repeat>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
21 <param name="remove_genotypes" label="Remove the genotype strings" type="boolean" truevalue="--remove-genotypes" falsevalue="" checked="False" />
da1a6f33b504 Imported from capsule None
devteam
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" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
23 </inputs>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
24 <tests>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
25 <test>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
26 <param name="input1" value="test.small.vcf" ftype="vcf" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
27 <param name="quality" value="9" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
28 <param name="info" value="NS 360 gt"/>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
29 <param name="remove_genotypes" value="" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
30 <param name="mark_as_pass" value="" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
31 <output name="output" file="test_filter_quality_9_NS_360_gt.vcf" lines_diff="6" ftype="vcf" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
32 </test>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
33 <test>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
34 <param name="input1" value="test.small.vcf" ftype="vcf" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
35 <param name="quality" value="9" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
36 <param name="info" value="DP 2000 lt"/>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
37 <param name="remove_genotypes" value="" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
38 <param name="mark_as_pass" value="" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
39 <output name="output" file="test_filter_quality_9_DP_2000_lt.vcf" lines_diff="6" ftype="vcf" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
40 </test>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
41 </tests>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
42 <outputs>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
43 <data format="vcf" name="output1" label="${tool.name} ${on_string}" />
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
44 </outputs>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
45 <help>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
46
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
47 **What it does**
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
48
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
49 This tool uses vcfPytools_' filter command
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
50
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
51 .. _vcfPytools: https://github.com/AlistairNWard/vcfPytools
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
52
da1a6f33b504 Imported from capsule None
devteam
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].
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
54
da1a6f33b504 Imported from capsule None
devteam
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:
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
56
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
57 DP 10 lt
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
58
da1a6f33b504 Imported from capsule None
devteam
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.
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
60
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
61 This option can be defined as many times as required.
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
62
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
63 </help>
da1a6f33b504 Imported from capsule None
devteam
parents:
diff changeset
64 </tool>