annotate t2t_report.xml @ 0:e7d70880851e draft default tip

Imported from capsule None
author devteam
date Thu, 23 Jan 2014 12:31:08 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="t2t_report" name="Summarize taxonomy" version="1.0.0">
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.0">taxonomy</requirement>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
6 <command>taxonomy2tree $input 0 /dev/null $out_file1 0</command>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
8 <param format="taxonomy" name="input" type="data" label="Summarize taxonomic representation for"/>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
9 </inputs>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
10 <outputs>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
11 <data format="tabular" name="out_file1" />
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
12 </outputs>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
13 <requirements>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
14 <requirement type="binary">taxonomy2tree</requirement>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
15 </requirements>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
16 <tests>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
17 <test>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
18 <param name="input" value="taxonomyGI.taxonomy" ftype="taxonomy"/>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
19 <output name="out_file1" file="t2t_report.tabular"/>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
20 </test>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
21 </tests>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
22
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
23
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
24 <help>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
25
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
26 **What it does**
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
27
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
28 Given taxonomy representation (produced by *Taxonomy manipulation->Fetch Taxonomic Ranks* tool) this utility computes a summary of all taxonomic ranks.
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
29
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
30 ------
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
31
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
32 **Example**
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
33
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
34 Suppose the *Taxonomy manipulation->Fetch Taxonomic Ranks* generated the following taxonomy representation::
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
35
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
36 9916 2 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Laurasiatheria n Ruminantia n Bovidae Bovinae n n Bos n Bos taurus n
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
37 9606 12585 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Euarchontoglires Primates Haplorrhini Hominoidea Hominidae n n n Homo n Homo sapiens n
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
38
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
39 Running this tool will generate the following output::
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
40
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
41 Rank Rank Name Count
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
42 -------------------------------------
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
43 root root 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
44 superkingdom Eukaryota 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
45 kingdom Metazoa 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
46 phylum Chordata 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
47 subphylum Craniata 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
48 superclass Gnathostomata 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
49 class Mammalia 2
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
50 superorder Euarchontoglires 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
51 superorder Laurasiatheria 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
52 order Primates 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
53 suborder Haplorrhini 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
54 suborder Ruminantia 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
55 superfamily Hominoidea 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
56 family Bovidae 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
57 family Hominidae 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
58 subfamily Bovinae 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
59 genus Bos 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
60 genus Homo 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
61 species Bos taurus 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
62 species Homo sapiens 1
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
63
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
64 The output is sorted on Rank and then on Rank Name.
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
65
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
66 .. class:: warningmark
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
67
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
68 **Note** that 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.
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
69
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
70
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
71 </help>
e7d70880851e Imported from capsule None
devteam
parents:
diff changeset
72 </tool>