annotate classify_blast.xml @ 7:de6dceb65136 draft

use default --prefix for install
author Jim Johnson <jj@umn.edu>
date Tue, 30 Oct 2012 12:38:17 -0500
parents 5f0f9a9b59e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
1 <tool id="classify_blast" name="Classify BLAST" version="1.0.0">
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
2 <description>results using KronaTools</description>
2
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 1
diff changeset
3 <requirements>
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 1
diff changeset
4 <requirement type="package" version="2.2">KronaTools</requirement>
5f0f9a9b59e3 Add package reqguirement for KronaTools
Jim Johnson <jj@umn.edu>
parents: 1
diff changeset
5 </requirements>
1
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6 <command>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
7 ktClassifyBLAST
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
8 -o $output
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
9 -e $factor
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 $random
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
11 #if $score == 'percentIdentity':
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 -p
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13 #elif $score == 'bitScore':
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 -b
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
15 #end if
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
16 $summarize
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
17 #for $input in $inputs
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18 ${input.input}
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 #end for
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 </command>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 <inputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 <repeat name="inputs" title="BLAST result">
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
24 <param name="input" format="tabular" type="data" label="BLAST result"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
25 </repeat>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 <param name="factor" type="float" value="10" label="E-value factor" help="For each query, hits with e-values within this factor of the best hit's e-value will be included when computing the lowest common ancestor (or picking randomly)."/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 <param name="random" type="boolean" truevalue="-r" falsevalue="" label="Random" help="Pick from hits within E-value factor randomly instead of finding the lowest common ancestor"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 <param name="score" type="select" label="Score by">
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 <option value="evalue">E-value</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
30 <option value="percentIdentity">Percent identity</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
31 <option value="bitScore">Bit score</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32 </param>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33 <param name="summarize" type="boolean" truevalue="-s" falsevalue="" label="Summarize" help="Sum results by taxonomy ID and list totals in the first column instead of query IDs"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 </inputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36 <outputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 <data format="tabular" name="output"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38 </outputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
39
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
40 <help>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
42 **What it does**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
44 Creates taxonomic classifications for each query in BLAST results by finding the lowest common ancestor (or by picking randomly, if specified) of "best" hits (as determined by e-value factor above). Requires a KronaTools_ installation (2.0 or higher) with taxonomy downloaded.
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
45
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
46 .. _KronaTools: http://krona.sourceforge.net
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
47
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
48 **Input**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
49
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50 Tabular BLAST results containing gi numbers. If comment lines are present, queries with no hits will be assigned to taxon -1 (consistent with MEGAN).
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
51
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
52 Example input (BLAST)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
53
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
54 1 2 3 4 5 6 7 8 9 10 11 12
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
55 read1 gi|211853080|gb|EQ846228.1| 97.33 150 1 3 6 154 9518999 9519146 5e-64 252
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56 read2 gi|211853080|gb|EQ846228.1| 96.69 151 0 5 6 154 9496147 9496294 2e-62 246
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
57
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
58 **Output**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
59
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
60 The output is a list of query IDs (or counts, if **summarize** is specified) followed by NCBI taxonomy IDs and scores. This can be used to create a Krona chart by specifying "Taxonomy ID list" as the **input type**. If the output is summarized, the **summarized** option must also be specified when creating the chart.
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
61
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
62 Example output (default)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
63
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
64 1 (query ID) 2 (tax ID) 3 (score)
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
65 read1 9606 94.34
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
66 read2 9616 32.17
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
67
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
68 Example output (summarized)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
69
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
70 1 (count) 2 (tax ID) 3 (score)
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
71 243 9606 94.34
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
72 17 9616 32.17
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
73
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
74 </help>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
75 <requirements>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
76 <requirement type="binary">ktClassifyBLAST</requirement>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
77 </requirements>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
78 </tool>