annotate classification.xml @ 6:3c50a937d7c1 draft

Uploaded
author bcclaywell
date Wed, 15 Apr 2015 19:14:23 -0400
parents d4690e65afcd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
1 <tool id="PHYLO_classification" name="Output classifications" version="2.1.0">
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
2 <description>in tabular format</description>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
3 <macros>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
4 <import>macros.xml</import>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
5 </macros>
6
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
6 <requirements>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
7 <requirement type="package">yapp_env</requirement>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
8 </requirements>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
9 <stdio>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
10 <expand macro="basic_errors"/>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
11 </stdio>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
12 <version_command>echo "pplacer $(pplacer --version)"</version_command>
0
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
13 <command interpreter="bash">
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
14 classification-wrapper.sh ${config}
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
15 </command>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
16 <inputs>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
17 <param name="split_map" type="data" format="csv" label="Read-to-specimen map"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
18 <param name="label_map" type="data" format="csv" label="Specimen-to-label map"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
19 <param name="class_db" type="data" format="sqlite3" label="Placement database"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
20 <param name="want_rank" type="select" label="Desired classification rank">
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
21 <option value="species" selected="true">Species</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
22 <option value="genus">Genus</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
23 <option value="family">Family</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
24 <option value="order">Order</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
25 <option value="class">Class</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
26 <option value="phylum">Phylum</option>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
27 </param>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
28 </inputs>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
29 <outputs>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
30 <data name="by_taxon" format="csv" label="By-taxon classification"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
31 <data name="by_specimen" format="csv" label="By-specimen classification"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
32 <data name="tallies_wide" format="csv" label="Tallies-wide classification"/>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
33 </outputs>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
34 <configfiles>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
35 <configfile name="config">
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
36 SPLIT_MAP="${split_map}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
37 LABEL_MAP="${label_map}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
38 CLASS_DB="${class_db}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
39 WANT_RANK="${want_rank}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
40
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
41 BY_TAXON="${by_taxon}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
42 BY_SPECIMEN="${by_specimen}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
43 TALLIES_WIDE="${tallies_wide}"
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
44 </configfile>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
45 </configfiles>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
46 <!-- The contents of the help tag is parsed as reStructuredText. Please see
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
47 help-template.rst for examples of commonly-used sections in other Galaxy
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
48 tools. -->
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
49 <help>
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
50
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
51 .. class:: infomark
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
52
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
53 **What it does**
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
54
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
55 This tool outputs the classifications made by ``pplacer`` to a tabular format
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
56 appropriate for use with R.
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
57
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
58 -----
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
59
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
60 **Example**
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
61
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
62 The classifications are simply done by containment. Say clade A of the
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
63 reference tree is the smallest such that contains a given placement. The most
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
64 specific classification for that read will be the lowest common ancestor of the
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
65 taxonomic classifications for the leaves of A. If the desired classification is
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
66 more specific than that, then we get a disconnect between the desired and the
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
67 actual classification. For example, if we try to classify at the species level
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
68 and the clade LCA is a genus, then we will get a genus name. If there is
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
69 uncertainty in read placement, then there is uncertainty in classification.
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
70
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
71 For example, here is a classification list made for one read using the tabular
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
72 output. The columns are as follows: read name, attempted rank for
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
73 classification, actual rank for classification, taxonomic identifier, and
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
74 confidence. You can see that in this example, there is some uncertainty at and
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
75 below species, but only one classification at the genus level::
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
76
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
77 GLKT0ZE01CQ2BU root root 1 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
78 GLKT0ZE01CQ2BU below_root below_root 131567 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
79 GLKT0ZE01CQ2BU superkingdom superkingdom 2 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
80 GLKT0ZE01CQ2BU below_superkingdom superkingdom 2 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
81 GLKT0ZE01CQ2BU below_below_superkingdom superkingdom 2 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
82 GLKT0ZE01CQ2BU superphylum superkingdom 2 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
83 GLKT0ZE01CQ2BU phylum phylum 1239 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
84 GLKT0ZE01CQ2BU subphylum phylum 1239 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
85 GLKT0ZE01CQ2BU class class 186801 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
86 GLKT0ZE01CQ2BU subclass class 186801 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
87 GLKT0ZE01CQ2BU order order 186802 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
88 GLKT0ZE01CQ2BU below_order order 186802 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
89 GLKT0ZE01CQ2BU below_below_order order 186802 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
90 GLKT0ZE01CQ2BU suborder order 186802 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
91 GLKT0ZE01CQ2BU family family 186804 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
92 GLKT0ZE01CQ2BU below_family family 186804 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
93 GLKT0ZE01CQ2BU genus genus 1257 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
94 GLKT0ZE01CQ2BU species_group genus 1257 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
95 GLKT0ZE01CQ2BU species_subgroup genus 1257 1
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
96 GLKT0ZE01CQ2BU species genus 1257 0.0732247
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
97 GLKT0ZE01CQ2BU species species 1261 0.853561
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
98 GLKT0ZE01CQ2BU species species 341694 0.073214
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
99 GLKT0ZE01CQ2BU below_species genus 1257 0.0732247
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
100 GLKT0ZE01CQ2BU below_species species 1261 0.853561
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
101 GLKT0ZE01CQ2BU below_species species 341694 0.073214
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
102
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
103 </help>
6
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
104 <citations>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
105 <expand macro="cite_pplacer"/>
3c50a937d7c1 Uploaded
bcclaywell
parents: 0
diff changeset
106 </citations>
0
d4690e65afcd Uploaded
bcclaywell
parents:
diff changeset
107 </tool>