annotate krona.xml @ 0:f8fdde273a2a draft

Uploaded
author jjohnson
date Mon, 29 Oct 2012 14:48:47 -0400
parents
children 5f0f9a9b59e3
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>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
3 <command>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
4 #if $type.program == 'galaxy':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
5 ktImportGalaxy
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
6 #else if $type.program == 'blast':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
7 ktImportBLAST
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
8 -e ${type.factor}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
9 ${type.random}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
10 #else
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
11 ktImportTaxonomy
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
12 ${type.summary}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
13 #end if
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
14 -o $output
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
15 ${type.include}
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
16
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
17 -d $depth
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
18
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
19 ## uncomment for isolated intranets (see README)
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
20 ##
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
21 ##-u /static/krona
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
22
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
23 #if $datasets.multiple == 'single':
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
24 $input
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
25 #else
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
26 $datasets.combine
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
27 #for $input in $datasets.inputs
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
28 ${input.file},'${input.name}'
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
29 #end for
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
30 #end if
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
31 </command>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
32
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
33 <inputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
34 <conditional name="type">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
35 <param name="program" label="Input type" type="select">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
36 <option value="galaxy">Galaxy taxonomic representation</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
37 <option value="blast">Tabular BLAST results</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
38 <option value="taxonomy">Taxonomy ID list</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
39 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
40 <when value="galaxy">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
41 <param name="factor" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
42 <param name="include" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
43 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
44 <when value="blast">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
45 <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
46 <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
47 <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
48 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
49 <when value="taxonomy">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
50 <param name="factor" type="hidden" value=""/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
51 <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
52 <param name="include" type="boolean" truevalue="-i" falsevalue="" label="Include reads with no hits"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
53 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
54 </conditional>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
55 <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
56 <conditional name="datasets">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
57 <param name="multiple" type="select" label="Number of datasets">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
58 <option value="single">Single</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
59 <option value="multiple">Multiple</option>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
60 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
61 <when value="single">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
62 <param name="input" type="data" format="tabular" label="Dataset"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
63 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
64 <when value="multiple">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
65 <param
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
66 name="combine"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
67 type="boolean"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
68 truevalue="-c"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
69 falsevalue=""
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
70 label="Combine data sets"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
71 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
72 />
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
73 <repeat name="inputs" title="Data set">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
74 <param
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
75 name="file"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
76 format="tabular"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
77 type="data"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
78 label="Data"
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
79 />
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
80 <param name="name" label="Name" type="text">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
81 <sanitizer>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
82 <valid initial="string.printable">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
83 <remove value="&quot;"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
84 </valid>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
85 <mapping initial="none">
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
86 <add source="&quot;" target="&amp;quot;"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
87 </mapping>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
88 </sanitizer>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
89 </param>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
90 </repeat>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
91 </when>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
92 </conditional>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
93 </inputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
94
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
95 <outputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
96 <data format="html" name="output"/>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
97 </outputs>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
98
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
99 <help>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
100
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
101 **What it does**
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
102
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
103 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
104
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
105 .. _Krona: http://krona.sourceforge.net
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
106
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
107 **Inputs**
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
108
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
109 The inputs can be Galaxy taxonomic representations, for example::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
110
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
111 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
112 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
113
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
114 ...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
115
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
116 1 2 3 4 5 6 7 8 9 10 11 12
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
117 read1 gi|211853080|gb|EQ846228.1| 97.33 150 1 3 6 154 9518999 9519146 5e-64 252
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
118 read2 gi|211853080|gb|EQ846228.1| 96.69 151 0 5 6 154 9496147 9496294 2e-62 246
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
119
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
120 ...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
121
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
122 1 2
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
123 read1 9606
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
124 read2 9616
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
125
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
126 Summarized::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
127
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
128 1 2
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
129 243 9606
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
130 17 9616
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
131
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
132 Both forms can optionally have scores::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
133
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
134 1 2 3
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
135 read1 9606 94.34
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
136 read2 9616 32.17
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
137
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
138 Summarized::
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
139
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
140 1 2 3
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
141 243 9606 94.34
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
142 17 9616 32.17
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
143
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
144 </help>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
145 <requirements>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
146 <requirement type="binary">ktImportGalaxy</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
147 <requirement type="binary">ktImportBLAST</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
148 <requirement type="binary">ktImportTaxonomy</requirement>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
149 </requirements>
f8fdde273a2a Uploaded
jjohnson
parents:
diff changeset
150 </tool>