Mercurial > repos > devteam > kraken_translate

annotate kraken-translate.xml @ 4:9a5be5b1a5c9 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-iuc/blob/master/tool_collections/kraken/ commit 06345505a91f3dcfa8a37dceb6f25e95806dddc8"
author iuc
date Wed, 04 Dec 2019 06:51:08 -0500
parents 9bdcba262627
children bc3e90fd13be
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
1 <tool id="kraken-translate" name="Kraken-translate" version="@WRAPPER_VERSION@">
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
2 <description>convert taxonomy IDs to names</description>
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
3 <macros>
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
4 <import>macros.xml</import>
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
5 </macros>
1
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
6 <expand macro="requirements" />
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
7 <expand macro="version_command" />
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
9 @SET_DATABASE_PATH@ &&
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
10
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
11 kraken-translate
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
12 @INPUT_DATABASE@
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
13 $mpa_format
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
14 '${input}'
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
15 > '${translated}'
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
16 ]]></command>
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
17 <inputs>
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
18 <param name="input" type="data" format="tabular" label="Kraken output"
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
19 help="Select taxonomy classification produced by kraken"/>
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
20 <param name="mpa_format" type="boolean" truevalue="--mpa-format" falsevalue=""
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
21 label="Restrict labels to standard rank assignments" />
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
22
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
23 <expand macro="input_database" />
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
24 </inputs>
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
25 <outputs>
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
26 <data name="translated" format="tabular" label="${tool.name} on ${on_string}: Translated classification"/>
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
27 </outputs>
1
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
28 <tests>
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
29 <test>
4
9a5be5b1a5c9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/ commit 06345505a91f3dcfa8a37dceb6f25e95806dddc8"
iuc
parents: 3
diff changeset
30 <param name="input" value="kraken-translate/kraken_translate_test1.tab" ftype="tabular"/>
1
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
31 <param name="mpa-format" value="false"/>
4
9a5be5b1a5c9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/ commit 06345505a91f3dcfa8a37dceb6f25e95806dddc8"
iuc
parents: 3
diff changeset
32 <param name="kraken_database" value="new_style_test_entry"/>
9a5be5b1a5c9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/ commit 06345505a91f3dcfa8a37dceb6f25e95806dddc8"
iuc
parents: 3
diff changeset
33 <output name="translated" file="kraken-translate/kraken_translate_test1_output.tab" ftype="tabular"/>
1
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
34 </test>
475284b74179 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 3abfc7eb2999fa588862b84c453012c811fa8350
devteam
parents: 0
diff changeset
35 </tests>
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
36 <help><![CDATA[
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
37
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
38 .. class:: warningmark
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
39
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
40 **Note**: the database used must be the same as the one used in the original Kraken run
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
41
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
42 -------
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
43
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
44 **What it does**
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
45
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
46 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::
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
47
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
48 C SEQ1 562 36 562:6
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
49
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
50 Would result in a corresponding output line from kraken-translate::
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
51
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
52 SEQ1 root;cellular organisms;Bacteria;Proteobacteria;Gammaproteobacteria;Enterobacteriales;Enterobacteriaceae;Escherichia;Escherichia coli
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
53
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
54 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`` with the above example output from kraken would result in the following line of output::
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
55
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
56 SEQ1 d__Bacteria|p__Proteobacteria|c__Gammaproteobacteria|o__Enterobacteriales|f__Enterobacteriaceae|g__Escherichia|s__Escherichia_coli
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
57
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
58 Taxonomy assignments above the superkingdom rank are represented as just "root" when using the ``--mpa-report`` option with kraken-translate.
3
9bdcba262627 planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/kraken_translate/ commit e8fc7c9dad5f583ad6763ecb9bd8c924832abacd
iuc
parents: 2
diff changeset
59 ]]></help>
0
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
60 <expand macro="citations" />
77ca66b1f5e9 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_translate/ commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
diff changeset
61 </tool>