annotate kraken-report.xml @ 5:6c09bed3444f draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit 659d4506dad485d853a91a6a6f8bed1e3c56e204
author iuc
date Thu, 13 Sep 2018 09:45:15 -0400
parents a3a7440fc618
children 1902d3de4a4f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
1 <tool id="kraken-report" name="Kraken-report" version="@WRAPPER_VERSION@">
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
2 <description>view sample report of a classification</description>
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
3
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
4 <macros>
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
5 <import>macros.xml</import>
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
6 </macros>
2
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
7 <expand macro="requirements" />
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
8 <expand macro="version_command" />
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
10 @SET_DATABASE_PATH@ &&
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
11
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
12 kraken-report
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
13 @INPUT_DATABASE@
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
14 '${kraken_output}'
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
15 > '$output_report'
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
16 ]]></command>
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
17 <inputs>
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
18 <param name="kraken_output" type="data" format="tabular" label="Kraken output" help="Select taxonomy classification produced by kraken"/>
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
19
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
20 <expand macro="input_database" />
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
21 </inputs>
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
22 <outputs>
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
23 <data format="tabular" name="output_report" />
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
24 </outputs>
2
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
25 <tests>
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
26 <test>
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
27 <param name="kraken_output" value="kraken_report_test1.tab" ftype="tabular"/>
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
28 <param name="kraken_database" value="test_db"/>
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
29 <output name="output_report" ftype="tabular" file="kraken_report_test1_output.tab"/>
2
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
30 </test>
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
31 </tests>
c4fb5dc47fce planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
32
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
33 <help><![CDATA[
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
34
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
35 .. class:: warningmark
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
36
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
37 **Note**: the database used must be the same as the one used in the original Kraken run
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
38
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
39 -----
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
40
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
41 **Output**
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
42
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
43 The output of kraken-report is tab-delimited, with one line per taxon. The fields of the output, from left-to-right, are as follows::
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
44
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
45 1. Percentage of reads covered by the clade rooted at this taxon
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
46 2. Number of reads covered by the clade rooted at this taxon
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
47 3. Number of reads assigned directly to this taxon
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
48 4. A rank code, indicating (U)nclassified, (D)omain, (K)ingdom, (P)hylum, (C)lass, (O)rder, (F)amily, (G)enus, or (S)pecies. All other ranks are simply filled with a dash.
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
49 5. NCBI taxonomy ID
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
50 6. Indented scientific name
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
51
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
52 The scientific names are indented using spaces, according to the tree
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
53 structure specified by the taxonomy.
4
a3a7440fc618 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 3
diff changeset
54 ]]></help>
0
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
55 <expand macro="citations" />
f2757ab26483 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
56 </tool>