annotate kraken-filter.xml @ 0:60d9479c58d6 draft

Uploaded
author devteam
date Wed, 22 Apr 2015 13:03:54 -0400
parents
children f093ba52debe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
1 <tool id="kraken-filter" name="Filter Kraken" version="1.0.0">
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
2 <description>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
3 by confidence score
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>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
8 <command>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
9 <![CDATA[
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
10 kraken-filter @INPUT_DATABASE@ --threshold $threshold "${input}" > "$filtered_output"
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
11 ]]>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
12 </command>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
13 <inputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
14 <param format="tabular" label="Kraken classified output" name="input" type="data" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
15 <param label="Confidence threshold" max="1" min="0" name="threshold" type="float" value="0" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
16 <expand macro="input_database" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
17 </inputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
18 <outputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
19 <data format="tabular" name="filtered_output" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
20 </outputs>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
21 <help>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
22 <![CDATA[
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
23
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
24 ***Note that the database used must be the same as the one used to generate
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
25 the output file, or the report script may encounter problems.***
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
26
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
27 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 given earlier:
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
28
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
29 "562:13 561:4 A:31 0:1 562:3" would indicate that:
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
30
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
31 the first 13 k-mers mapped to taxonomy ID #562
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
32 the next 4 k-mers mapped to taxonomy ID #561
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
33 the next 31 k-mers contained an ambiguous nucleotide
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
34 the next k-mer was not in the database
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
35 the last 3 k-mers mapped to taxonomy ID #562
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
36
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
37 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
38 ]]>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
39 </help>
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
40 <expand macro="version_command" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
41 <expand macro="requirements" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
42 <expand macro="stdio" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
43 <expand macro="citations" />
60d9479c58d6 Uploaded
devteam
parents:
diff changeset
44 </tool>