annotate kraken-report.xml @ 4:9709eedcff4b draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
author devteam
date Fri, 18 Dec 2015 19:41:35 -0500
parents 45ced9c12e18
children e9e42bf5c6a8
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>
4
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
5
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
6 <macros>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
7 <import>macros.xml</import>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
8 </macros>
4
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
9 <expand macro="requirements" />
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
10 <expand macro="stdio" />
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
11 <expand macro="version_command" />
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
12 <command>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
13 <![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
14 @SET_DATABASE_PATH@ &&
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
15 kraken-report @INPUT_DATABASE@ "${kraken_output}" > "$output_report"
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
16 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
17 </command>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
18 <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
19 <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
20 <expand macro="input_database" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
21 </inputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
22 <outputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
23 <data format="tabular" name="output_report" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
24 </outputs>
4
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
25 <tests>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
26 <test>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
27 <param name="kraken_output" value="kraken_report_test1.tab" ftype="tabular"/>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
28 <param name="kraken_database" value="test_db"/>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
29 <output name="output_report" file="kraken_report_test1_output.tab" ftype="tabular"/>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
30 </test>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
31 </tests>
9709eedcff4b planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_report/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
32
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
33 <help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
34 <![CDATA[
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
35
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
36 .. class:: warningmark
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
37
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
38 **Note**: the database used must be the same as the one used in the original Kraken run
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
39
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
40 -----
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
41
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
42 **Output**
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
43
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
44 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
45
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
46 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
47 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
48 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
49 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
50 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
51 6. Indented scientific name
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
52
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
53 The scientific names are indented using spaces, according to the tree
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
54 structure specified by the taxonomy.
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
55 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
56 </help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
57 <expand macro="citations" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
58 </tool>