annotate find_diag_hits.xml @ 0:acf51ff24c7d draft default tip

Imported from capsule None
author devteam
date Mon, 27 Jan 2014 09:25:21 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="find_diag_hits" name="Find diagnostic hits" version="1.0.0">
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.0">taxonomy</requirement>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
6 <command interpreter="python">find_diag_hits.py $input1 $id_col $rank_list $out_format $out_file1</command>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
8 <param format="taxonomy" name="input1" type="data" label="Find diagnostic hits in"/>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
9 <param name="id_col" type="data_column" data_ref="input1" numerical="False" label="Select column with sequence id" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
10 <param name="rank_list" type="select" display="checkboxes" multiple="true" label="select taxonomic ranks">
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
11 <option value="superkingdom">Superkingdom</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
12 <option value="kingdom">Kingdom</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
13 <option value="subkingdom">Subkingdom</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
14 <option value="superphylum">Superphylum</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
15 <option value="phylum">Phylum</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
16 <option value="subphylum">Subphylum</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
17 <option value="superclass">Superclass</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
18 <option value="class">Class</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
19 <option value="subclass">Subclass</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
20 <option value="superorder">Superorder</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
21 <option value="order">Order</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
22 <option value="suborder">Suborder</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
23 <option value="superfamily">Superfamily</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
24 <option value="family">Family</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
25 <option value="subfamily">Subfamily</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
26 <option value="tribe">Tribe</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
27 <option value="subtribe">Subtribe</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
28 <option value="genus">Genus</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
29 <option value="subgenus">Subgenus</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
30 <option selected="true" value="species">Species</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
31 <option value="subspecies">Subspecies</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
32 </param>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
33 <param name="out_format" type="select" label="Select output format">
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
34 <option value="reads">Diagnostic read list</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
35 <option value="counts">Number of diagnostic reads per taxonomic rank</option>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
36 </param>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
37 </inputs>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
38 <outputs>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
39 <data format="tabular" name="out_file1" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
40 </outputs>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
41 <tests>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
42 <test>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
43 <param name="input1" value="taxonomyGI.taxonomy" ftype="taxonomy"/>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
44 <param name="id_col" value="1" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
45 <param name="rank_list" value="order,genus" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
46 <param name="out_format" value="counts" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
47 <output name="out_file1" file="find_diag_hits.tabular" />
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
48 </test>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
49 </tests>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
50
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
51
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
52 <help>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
53
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
54 **What it does**
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
55
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
56 When performing metagenomic analyses it is often necessary to identify sequence reads corresponding to a particular taxonomic group, or, in other words, diagnostic of a particular taxonomic rank. This utility performs this analysis. It takes data generated by *Taxonomy manipulation->Fetch Taxonomic Ranks* as input and outputs either a list of sequence reads unique to a particular taxonomic rank, or a list of taxonomic ranks and the count of unique reads corresponding to each rank.
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
57
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
58 ------
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
59
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
60 **Example**
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
61
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
62 Suppose the *Taxonomy manipulation->Fetch Taxonomic Ranks* generated the following taxonomy representation::
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
63
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
64 read1 2 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Laurasiatheria n Ruminantia n Bovidae Bovinae n n Bos n Bos taurus n
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
65 read2 12585 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Euarchontoglires Primates Haplorrhini Hominoidea Hominidae n n n Homo n Homo sapiens n
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
66 read1 58615 root Eukaryota Metazoa n n Arthropoda n Hexapoda Insecta Neoptera Amphiesmenoptera Lepidoptera Glossata Papilionoidea Nymphalidae Nymphalinae Melitaeini Phyciodina Anthanassa n Anthanassa otanes n
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
67 read3 56785 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Euarchontoglires Primates Haplorrhini Hominoidea Hominidae n n n Homo n Homo sapiens n
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
68
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
69 Running this tool with the following parameters:
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
70
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
71 * *Select column with sequence id* set to **c1**
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
72 * *Select taxonomic ranks* with **order**, and **genus** checked
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
73 * *Output format* set to **Diagnostic read list**
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
74
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
75 will return::
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
76
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
77 read2 Primates order
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
78 read3 Primates order
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
79 read2 Homo genus
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
80 read3 Homo genus
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
81
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
82 Changing *Output format* set to **Number of diagnostic reads per taxonomic rank** will produce::
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
83
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
84 Primates 2 order
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
85 Homo 2 genus
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
86
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
87 .. class:: infomark
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
88
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
89 Note that **read1** is omitted because it is non-unique: it hits Mammals and Insects at the same time.
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
90
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
91 --------
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
92
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
93 .. class:: warningmark
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
94
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
95 This tool omits "**n**" corresponding to ranks missing from NCBI taxonomy. In the above example *Home sapiens* contains the order name (Primates) while *Bos taurus* does not.
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
96
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
97
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
98 </help>
acf51ff24c7d Imported from capsule None
devteam
parents:
diff changeset
99 </tool>