Mercurial > repos > devteam > kraken_report

annotate kraken-report.xml @ 3:a539aeea69fc draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit ce0de4de3fa3fc25c375e378ac84f78452dd61c3
author devteam
date Wed, 05 Aug 2015 12:13:09 -0400
parents 45ced9c12e18
children 9709eedcff4b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
1 <tool id="kraken-report" name="Kraken-report" version="1.1.0">
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
2 <description>
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
3 view a sample report of your classification
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
4 </description>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
5 <macros>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
6 <import>macros.xml</import>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
7 </macros>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
8 <command>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
9 <![CDATA[
1
bb3d55e8ef3d planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb1743eafd4ca98be0148d557770ef8635cc8d4c-dirty
devteam
parents: 0
diff changeset
10 @SET_DATABASE_PATH@ &&
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
11 kraken-report @INPUT_DATABASE@ "${kraken_output}" > "$output_report"
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
12 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
13 </command>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
14 <inputs>
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
15 <param format="tabular" label="Kraken output" name="kraken_output" type="data" help="Select taxonomy classification produced by kraken"/>
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
16 <expand macro="input_database" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
17 </inputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
18 <outputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
19 <data format="tabular" name="output_report" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
20 </outputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
21 <help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
22 <![CDATA[
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
23
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
24 .. class:: warningmark
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
25
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
26 **Note**: the database used must be the same as the one used in the original Kraken run
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
27
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
28 -----
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
29
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
30 **Output**
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
31
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
32 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::
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
33
2
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
34 1. Percentage of reads covered by the clade rooted at this taxon
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
35 2. Number of reads covered by the clade rooted at this taxon
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
36 3. Number of reads assigned directly to this taxon
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
37 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.
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
38 5. NCBI taxonomy ID
45ced9c12e18 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
39 6. Indented scientific name
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
40
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
41 The scientific names are indented using spaces, according to the tree
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
42 structure specified by the taxonomy.
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
43 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
44 </help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
45 <expand macro="version_command" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
46 <expand macro="requirements" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
47 <expand macro="stdio" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
48 <expand macro="citations" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
49 </tool>