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