annotate kraken-translate.xml @ 0:fdd8eeb5a10d draft

Uploaded
author devteam
date Wed, 22 Apr 2015 13:04:21 -0400
parents
children f23c90363093
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
1 <tool id="kraken-translate" name="Kraken-translate" version="1.0.0">
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
2 <description>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
3 convert taxonomy IDs to names
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
4 </description>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
5 <macros>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
6 <import>macros.xml</import>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
7 </macros>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
8 <command>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
9 <![CDATA[
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
10 kraken-translate @INPUT_DATABASE@ $mpa_format "${input}" > "${translated}"
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
11 ]]>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
12 </command>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
13 <inputs>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
14 <param format="tabular" label="Kraken classification" name="input" type="data" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
15 <param label="Restrict labels to standard rank assignments" name="mpa_format" truevalue="--mpa-format" falsevalue="" type="boolean" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
16 <expand macro="input_database" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
17 </inputs>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
18 <outputs>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
19 <data format="tabular" label="${tool.name} on ${on_string}: Translated classification" name="translated" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
20 </outputs>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
21 <help>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
22 <![CDATA[
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
23 **What it does**
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
24
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
25 The file sequences.labels generated by the above example is a text file with two tab-delimited columns, and one line for each classified sequence in sequences.fa; unclassified sequences are not reported by kraken-translate. The first column of kraken-translate's output are the sequence IDs of the classified sequences, and the second column contains the taxonomy of the sequence. For example, an output line from kraken of:
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
26
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
27 C SEQ1 562 36 562:6
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
28
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
29 Would result in a corresponding output line from kraken-translate of:
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
30
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
31 SEQ1 root;cellular organisms;Bacteria;Proteobacteria;Gammaproteobacteria;Enterobacteriales;Enterobacteriaceae;Escherichia;Escherichia coli
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
32
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
33 Alternatively, kraken-translate accepts the option --mpa-format which will report only levels of the taxonomy with standard rank assignments (superkingdom, kingdom, phylum, class, order, family, genus, species), and uses pipes to delimit the various levels of the taxonomy. For example, kraken-translate --mpa-format --db $DBNAME with the above example output from kraken would result in the following line of output:
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
34
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
35 SEQ1 d__Bacteria|p__Proteobacteria|c__Gammaproteobacteria|o__Enterobacteriales|f__Enterobacteriaceae|g__Escherichia|s__Escherichia_coli
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
36
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
37 Taxonomy assignments above the superkingdom (d__) rank are represented as just "root" when using the --mpa-report option with kraken-translate.
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
38 ]]>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
39 </help>
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
40 <expand macro="requirements" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
41 <expand macro="stdio" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
42 <expand macro="version_command" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
43 <expand macro="citations" />
fdd8eeb5a10d Uploaded
devteam
parents:
diff changeset
44 </tool>