annotate kraken-report.xml @ 0:8bbf903bf0cb draft

Uploaded
author devteam
date Wed, 22 Apr 2015 13:04:06 -0400
parents
children bb3d55e8ef3d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
1 <tool id="kraken-report" name="Kraken-report" version="1.0.0">
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
2 <description>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
3 View a sample report of your classification
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[
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
10 kraken-report @INPUT_DATABASE@ "${kraken_output}" > "$output_report"
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
11 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
12 </command>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
13 <inputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
14 <param format="tabular" label="Input the Sequenced Kraken Output from your Current History" name="kraken_output" type="data" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
15 <expand macro="input_database" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
16 </inputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
17 <outputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
18 <data format="tabular" name="output_report" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
19 </outputs>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
20 <help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
21 <![CDATA[
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
22
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
23 ***Note that the database used must be the same as the one used to generate
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
24 the output file, or the report script may encounter problems.***
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
25
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
26
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
27
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
28 **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:**
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
29
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
30 1)Percentage of reads covered by the clade rooted at this taxon
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
31
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
32 2)Number of reads covered by the clade rooted at this taxon
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
33
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
34 3)Number of reads assigned directly to this taxon
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
35
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
36 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 -.
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
37
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
38 5)NCBI taxonomy ID
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
39
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
40 6)Indented scientific name
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
41
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
42 The scientific names are indented using spaces, according to the tree
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
43 structure specified by the taxonomy.
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
44 ]]>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
45 </help>
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
46 <expand macro="version_command" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
47 <expand macro="requirements" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
48 <expand macro="stdio" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
49 <expand macro="citations" />
8bbf903bf0cb Uploaded
devteam
parents:
diff changeset
50 </tool>