annotate gi2taxonomy.xml @ 0:7b1b03c4465d draft default tip

Imported from capsule None
author devteam
date Mon, 27 Jan 2014 09:28:26 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="Fetch Taxonomic Ranks" name="Fetch taxonomic representation" version="1.1.0">
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.0">taxonomy</requirement>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
6 <command interpreter="python">gi2taxonomy.py $input $giField $idField $out_file1 ${GALAXY_DATA_INDEX_DIR}</command>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
8 <param format="tabular" name="input" type="data" label="Show taxonomic representation for"></param>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
9 <param name="giField" label="GIs column" type="data_column" data_ref="input" numerical="True" help="select column containing GI numbers"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
10 <param name="idField" label="Name column" type="data_column" data_ref="input" help="select column containing identifiers you want to include into output"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
11 </inputs>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
12 <outputs>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
13 <data format="taxonomy" name="out_file1" />
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
14 </outputs>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
15 <requirements>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
16 <requirement type="binary">taxBuilder</requirement>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
17 </requirements>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
18 <tests>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
19 <test>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
20 <param name="input" ftype="tabular" value="taxonomy2gi-input.tabular"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
21 <param name="giField" value="1"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
22 <param name="idField" value="2"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
23 <output name="out_file1" file="taxonomy2gi-output.tabular"/>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
24 </test>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
25 </tests>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
26
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
27 <help>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
28
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
29 .. class:: infomark
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
30
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
31 Use *Filter and Sort->Filter* to restrict output of this tool to desired taxonomic ranks. You can also use *Text Manipulation->Cut* to remove unwanted columns from the output.
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
32
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
33 ------
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
34
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
35 **What it does**
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
36
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
37 Fetches taxonomic information for a list of GI numbers (sequences identifiers used by the National Center for Biotechnology Information http://www.ncbi.nlm.nih.gov).
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
38
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
39 -------
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
40
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
41 **Example**
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
42
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
43 Suppose you have BLAST output that looks like this::
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
44
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
45 +-----------------------+----------+----------+-----------------+------------+------+--------+
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
46 | queryId | targetGI | identity | alignmentLength | mismatches | gaps | score |
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
47 +-----------------------+----------+----------+-----------------+------------+------+--------+
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
48 | 1L_EYKX4VC01BXWX1_265 | 1430919 | 90.09 | 212 | 15 | 6 | 252.00 |
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
49 +-----------------------+----------+----------+-----------------+------------+------+--------+
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
50
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
51 and you want to obtain full taxonomic representation for GIs listed in *targetGI* column. If you set parameters as shown here:
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
52
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
53 .. image:: ${static_path}/images/fetchTax.png
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
54
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
55
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
56 the tool will generate the following output (you may need to scroll sideways to see the entire line)::
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
57
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
58 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
59 1L_EYKX4VC01BXWX1_265 9606 root Eukaryota Metazoa n n Chordata Craniata Gnathostomata Mammalia n Euarchontoglires Primates Haplorrhini Hominoidea Hominidae n n n Homo n Homo sapiens n 1430919
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
60
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
61 In other words the tool printed *Name column*, *taxonomy Id*, appended 22 columns containing taxonomic ranks from Superkingdom to Subspecies and added *GI* as the last column. Below is a formal definition of the output columns::
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
62
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
63 Column Definition
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
64 ------- ------------------------------------------
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
65 1 Name (specified by 'Name column' dropdown)
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
66 2 GI (specified by 'GI column' dropdown)
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
67 3 root
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
68 4 superkingdom
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
69 5 kingdom
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
70 6 subkingdom
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
71 7 superphylum
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
72 8 phylum
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
73 9 subphylum
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
74 10 superclass
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
75 11 class
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
76 12 subclass
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
77 13 superorder
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
78 14 order
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
79 15 suborder
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
80 16 superfamily
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
81 17 family
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
82 18 subfamily
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
83 19 tribe
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
84 20 subtribe
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
85 21 genus
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
86 22 subgenus
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
87 23 species
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
88 24 subspecies
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
89
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
90 ------
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
91
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
92 .. class:: warningmark
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
93
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
94 **Why do I have these "n" things?**
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
95
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
96 Be aware that the NCBI taxonomy (ftp://ftp.ncbi.nih.gov/pub/taxonomy/) this tool relies upon is incomplete. This means that for many species one or more ranks are absent and represented as "**n**". In the above example *subkingdom*, *superphylum* etc. are missing.
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
97
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
98
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
99 </help>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
100 </tool>
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
101
7b1b03c4465d Imported from capsule None
devteam
parents:
diff changeset
102