annotate kraken-report.xml @ 8:196f2cf1f0a1 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:44:00 -0400
parents 1c163820e346
children 8ddbdc9cdc57
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
1 <tool id="kraken-report" name="Kraken-report" version="@WRAPPER_VERSION@">
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
2 <description>view sample report of a classification</description>
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
3
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
4 <macros>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
5 <import>macros.xml</import>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
6 </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
7 <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
8 <expand macro="version_command" />
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
9 <command detect_errors="exit_code"><![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@ &&
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
11
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
12 kraken-report
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
13 @INPUT_DATABASE@
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
14 '${kraken_output}'
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
15 > '$output_report'
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
16 ]]></command>
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
17 <inputs>
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
18 <param name="kraken_output" type="data" format="tabular" label="Kraken output" help="Select taxonomy classification produced by kraken"/>
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
19
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"/>
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
29 <output name="output_report" ftype="tabular" file="kraken_report_test1_output.tab"/>
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
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
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
33 <help><![CDATA[
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
34
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
35 .. class:: warningmark
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
36
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
37 **Note**: the database used must be the same as the one used in the original Kraken run
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
38
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
39 -----
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
40
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
41 **Output**
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
42
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
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::
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
44
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
45 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
46 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
47 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
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.
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 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
50 6. Indented scientific name
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
51
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
52 The scientific names are indented using spaces, according to the tree
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
53 structure specified by the taxonomy.
7
1c163820e346 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_report/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 6
diff changeset
54 ]]></help>
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
55 <expand macro="citations" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
56 </tool>