annotate tools/taxonomy/lca.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="lca1" name="Find lowest diagnostic rank" version="1.0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description></description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <requirement type="package">taxonomy</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 lca.py $input1 $out_file1 $rank_bound
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <param format="taxonomy" name="input1" type="data" label="for taxonomy dataset"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <param name="rank_bound" label="require the lowest rank to be at least" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <option value="0">No restriction</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <option value="3">Superkingdom</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <option value="4">Kingdom</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <option value="5">Subkingdom</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <option value="6">Superphylum</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <option value="7">Phylum</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <option value="8">Subphylum</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <option value="9">Superclass</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <option value="10">Class</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <option value="11">Subclass</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <option value="12">Superorder</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <option value="13">Order</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <option value="14">Suborder</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <option value="15">Superfamily</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <option value="16">Family</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <option value="17">Subfamily</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <option value="18">Tribe</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <option value="19">Subtribe</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <option value="20">Genus</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <option value="21">Subgenus</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <option value="22">Species</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <option value="23">Subspecies</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <data format="taxonomy" name="out_file1" metadata_source="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <param name="input1" value="lca_input.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <param name="rank_bound" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <output name="out_file1" file="lca_output.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <param name="input1" value="lca_input2.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <param name="rank_bound" value="7" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <output name="out_file1" file="lca_output2.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 <!--Test case with invalid lines -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <param name="input1" value="lca_input3.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <param name="rank_bound" value="10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <output name="out_file1" file="lca_output3.taxonomy" ftype="taxonomy"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 This tool identifies the lowest taxonomic rank for which a mategenomic sequencing read is diagnostic. It takes datasets produced by *Fetch Taxonomic Ranks* tool (aka Taxonomy format) as the input.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 -------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 Suppose you have two reads, **read_1** and **read_2**, with the following taxonomic profiles (scroll sideways to see the entire dataset)::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 read_1 1 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum1 subphylum1 superclass1 class1 subclass1 superorder1 order1 suborder1 superfamily1 family1 subfamily1 tribe1 subtribe1 genus1 subgenus1 species1 subspecies1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 read_1 2 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum1 subphylum1 superclass1 class1 subclass1 superorder1 order1 suborder1 superfamily1 family1 subfamily1 tribe1 subtribe1 genus2 subgenus2 species2 subspecies2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 read_2 3 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum3 subphylum3 superclass3 class3 subclass3 superorder3 order3 suborder3 superfamily3 family3 subfamily3 tribe3 subtribe3 genus3 subgenus3 species3 subspecies3
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 read_2 4 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum4 subphylum4 superclass4 class4 subclass4 superorder4 order4 suborder4 superfamily4 family4 subfamily4 tribe4 subtribe4 genus4 subgenus4 species4 subspecies4
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 For **read_1** taxonomic labels are consistent until the genus level, where the taxonomy splits into two branches, one ending with *subspecies1* and the other with *subspecies2*. This implies **that the lowest taxomomic rank read_1 can identify is SUBTRIBE**. Similarly, read_2 is diagnostic up until the **superphylum** level. As a results the output of this tool will be::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 read_1 2 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum1 subphylum1 superclass1 class1 subclass1 superorder1 order1 suborder1 superfamily1 family1 subfamily1 tribe1 subtribe1 n n n n
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 read_2 3 root superkingdom1 kingdom1 subkingdom1 superphylum1 n n n n n n n n n n n n n n n n n
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 where, **n** means *EMPTY*.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 --------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 **What's up with the drop down?**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 Why do we need the *require the lowest rank to be at least* dropdown? Let's look at the above example again. Suppose you need to find only those reads that are diagnostic on at least phylum level. To do this you need to set the *require the lowest rank to be at least* to **phylum**. As a result your output will look like this::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 read_1 2 root superkingdom1 kingdom1 subkingdom1 superphylum1 phylum1 subphylum1 superclass1 class1 subclass1 superorder1 order1 suborder1 superfamily1 family1 subfamily1 tribe1 subtribe1 n n n n
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 Note, that **read_2** is now omitted as it matches two phyla (**phylum3** and **phylum4**) and therefore is not diagnostic (but rather cosmopolitan) on *phylum* level.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 </tool>