Mercurial > repos > devteam > kraken_filter

annotate kraken-filter.xml @ 3:7fb926851f66 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-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
author devteam
date Fri, 18 Dec 2015 19:41:19 -0500
parents 317726be0703
children d2c12af1943a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
1 <tool id="kraken-filter" name="Kraken-filter" version="1.1.0">
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
2 <description>
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
3 filter classification by confidence score
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
4 </description>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
5 <macros>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
6 <import>macros.xml</import>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
7 </macros>
3
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
8 <expand macro="requirements" />
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
9 <expand macro="stdio" />
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
10 <expand macro="version_command" />
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
11 <command>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
12 <![CDATA[
1
f093ba52debe planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb1743eafd4ca98be0148d557770ef8635cc8d4c-dirty
devteam
parents: 0
diff changeset
13 @SET_DATABASE_PATH@ &&
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
14 kraken-filter @INPUT_DATABASE@ --threshold $threshold "${input}" > "$filtered_output"
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
15 ]]>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
16 </command>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
17 <inputs>
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
18 <param format="tabular" label="Kraken output" name="input" type="data" help="Select taxonomy classification produced by kraken"/>
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
19 <param label="Confidence threshold" max="1" min="0" name="threshold" type="float" value="0" help="--threshold; A number between 0 and 1; default=0"/>
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
20 <expand macro="input_database" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
21 </inputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
22 <outputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
23 <data format="tabular" name="filtered_output" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
24 </outputs>
3
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
25 <tests>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
26 <test>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
27 <param name="input" value="kraken_filter_test1.tab"/>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
28 <param name="threshold" value="0"/>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
29 <param name="kraken_database" value="test_db"/>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
30 <output name="output" file="kraken_filter_test1_output.tab" ftype="tabular"/>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
31 </test>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
32 </tests>
7fb926851f66 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
devteam
parents: 2
diff changeset
33
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
34 <help>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
35 <![CDATA[
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
36
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
37 .. class:: warningmark
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
38
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
39 **Note**: the database used must be the same as the one used in the original Kraken run
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
40
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
41 -----
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
42
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
43 **What it does**
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
44
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
45 At present, we have not yet developed a confidence score with a solid probabilistic interpretation for Kraken. However, we have developed a simple scoring scheme that has yielded good results for us, and we've made that available in the kraken-filter script. The approach we use allows a user to specify a threshold score in the [0,1] interval; the ``kraken-filter`` script then will adjust labels up the tree until the label's score (described below) meets or exceeds that threshold. If a label at the root of the taxonomic tree would not have a score exceeding the threshold, the sequence is called unclassified by ``kraken-filter``.
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
46
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
47 A sequence label's score is a fraction C/Q, where C is the number of k-mers mapped to LCA values in the clade rooted at the label, and Q is the number of k-mers in the sequence that lack an ambiguous nucleotide (i.e., they were queried against the database). Consider the example of the LCA mappings in Kraken's output::
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
48
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
49 562:13 561:4 A:31 0:1 562:3
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
50
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
51 would indicate that::
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
52
2
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
53 the first 13 k-mers mapped to taxonomy ID #562
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
54 the next 4 k-mers mapped to taxonomy ID #561
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
55 the next 31 k-mers contained an ambiguous nucleotide
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
56 the next k-mer was not in the database
317726be0703 planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken_filter/ commit cb6ebb843c71dcfc73aa05cc616f8e3229170108-dirty
devteam
parents: 1
diff changeset
57 the last 3 k-mers mapped to taxonomy ID #562
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
58
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
59 In this case, ID #561 is the parent node of #562. Here, a label of #562 for this sequence would have a score of C/Q = (13+3)/(13+4+1+3) = 16/21. A label of #561 would have a score of C/Q = (13+4+3)/(13+4+1+3) = 20/21. If a user specified a threshold over 16/21, kraken-filter would adjust the original label from #562 to #561; if the threshold was greater than 20/21, the sequence would become unclassified.
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
60 ]]>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
61 </help>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
62 <expand macro="citations" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
63 </tool>