annotate krona.xml @ 3:3398919bc103 draft

Comment tool_dependencies.xml
author Jim Johnson <jj@umn.edu>
date Mon, 29 Oct 2012 16:05:59 -0500
parents 5f0f9a9b59e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
1 <tool id="krona" name="Krona chart" version="1.1.0">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
2 <description>of taxonomic abundance</description>
2
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
3 <requirements>
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
4 <requirement type="package" version="2.2">KronaTools</requirement>
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
5 </requirements>
0
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
6 <command>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
7 #if $type.program == 'galaxy':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
8 ktImportGalaxy
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
9 #else if $type.program == 'blast':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
10 ktImportBLAST
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
11 -e ${type.factor}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
12 ${type.random}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
13 #else
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
14 ktImportTaxonomy
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
15 ${type.summary}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
16 #end if
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
17 -o $output
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
18 ${type.include}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
19
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
20 -d $depth
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
21
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
22 ## uncomment for isolated intranets (see README)
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
23 ##
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
24 ##-u /static/krona
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
25
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
26 #if $datasets.multiple == 'single':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
27 $input
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
28 #else
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
29 $datasets.combine
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
30 #for $input in $datasets.inputs
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
31 ${input.file},'${input.name}'
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
32 #end for
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
33 #end if
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
34 </command>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
35
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
36 <inputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
37 <conditional name="type">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
38 <param name="program" label="Input type" type="select">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
39 <option value="galaxy">Galaxy taxonomic representation</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
40 <option value="blast">Tabular BLAST results</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
41 <option value="taxonomy">Taxonomy ID list</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
42 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
43 <when value="galaxy">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
44 <param name="factor" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
45 <param name="include" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
46 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
47 <when value="blast">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
48 <param name="factor" type="float" value="10" label="E-value factor" help="For each query, hits with e-values within this factor of the best hit's e-value will be included when computing the lowest common ancestor."/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
49 <param name="include" type="boolean" truevalue="-i" falsevalue="" label="Include reads with no hits (comment lines must be present in BLAST results)"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
50 <param name="random" type="boolean" truevalue="-r" falsevalue="" label="Random" help="Pick from hits within E-value factor randomly instead of finding the lowest common ancestor"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
51 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
52 <when value="taxonomy">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
53 <param name="factor" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
54 <param name="summary" type="boolean" truevalue="-m 1" falsevalue="" label="Summarized" help="The first column is counts rather than query IDs."/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
55 <param name="include" type="boolean" truevalue="-i" falsevalue="" label="Include reads with no hits"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
56 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
57 </conditional>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
58 <param name="depth" label="Depth" type="integer" help="The maximum depth to show in the chart (0 for unlimited)." value="0"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
59 <conditional name="datasets">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
60 <param name="multiple" type="select" label="Number of datasets">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
61 <option value="single">Single</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
62 <option value="multiple">Multiple</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
63 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
64 <when value="single">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
65 <param name="input" type="data" format="tabular" label="Dataset"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
66 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
67 <when value="multiple">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
68 <param
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
69 name="combine"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
70 type="boolean"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
71 truevalue="-c"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
72 falsevalue=""
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
73 label="Combine data sets"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
74 help="By default, data sets can be stepped through to see varying abundances. Combining them will sum the data sets at each node to represent total abundances."
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
75 />
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
76 <repeat name="inputs" title="Data set">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
77 <param
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
78 name="file"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
79 format="tabular"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
80 type="data"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
81 label="Data"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
82 />
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
83 <param name="name" label="Name" type="text">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
84 <sanitizer>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
85 <valid initial="string.printable">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
86 <remove value="&quot;"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
87 </valid>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
88 <mapping initial="none">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
89 <add source="&quot;" target="&amp;quot;"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
90 </mapping>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
91 </sanitizer>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
92 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
93 </repeat>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
94 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
95 </conditional>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
96 </inputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
97
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
98 <outputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
99 <data format="html" name="output"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
100 </outputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
101
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
102 <help>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
103
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
104 **What it does**
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
105
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
106 Creates an interactive Krona_ chart of taxonomic abundance. Requires a KronaTools installation (2.0 or higher) with taxonomy downloaded.
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
107
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
108 .. _Krona: http://krona.sourceforge.net
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
109
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
110 **Inputs**
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
111
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
112 The inputs can be Galaxy taxonomic representations, for example::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
113
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
114 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
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
115 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
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
116
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
117 ...or, they can be tabular BLAST results containing gi numbers, which will be used to look up taxonomy IDs and find lowest common ancestors for best hits (comment lines are optional but required for showing queries with no hits in the chart)::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
118
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
119 1 2 3 4 5 6 7 8 9 10 11 12
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
120 read1 gi|211853080|gb|EQ846228.1| 97.33 150 1 3 6 154 9518999 9519146 5e-64 252
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
121 read2 gi|211853080|gb|EQ846228.1| 96.69 151 0 5 6 154 9496147 9496294 2e-62 246
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
122
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
123 ...or, they can be lists of taxonomy IDs preceded by query IDs or counts (these formats can be exported by ktClassifyBLAST or MEGAN), but **Summarized** must be checked if they are counts::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
124
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
125 1 2
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
126 read1 9606
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
127 read2 9616
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
128
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
129 Summarized::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
130
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
131 1 2
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
132 243 9606
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
133 17 9616
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
134
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
135 Both forms can optionally have scores::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
136
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
137 1 2 3
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
138 read1 9606 94.34
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
139 read2 9616 32.17
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
140
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
141 Summarized::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
142
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
143 1 2 3
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
144 243 9606 94.34
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
145 17 9616 32.17
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
146
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
147 </help>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
148 <requirements>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
149 <requirement type="binary">ktImportGalaxy</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
150 <requirement type="binary">ktImportBLAST</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
151 <requirement type="binary">ktImportTaxonomy</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
152 </requirements>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
153 </tool>