annotate classify_blast.xml @ 1:53258f6dddd3 draft

Add tool_dependencies.xml
author Jim Johnson <jj@umn.edu>
date Mon, 29 Oct 2012 13:52:47 -0500
parents
children 5f0f9a9b59e3
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>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
3 <command>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
4 ktClassifyBLAST
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5 -o $output
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6 -e $factor
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
7 $random
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
8 #if $score == 'percentIdentity':
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
9 -p
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 #elif $score == 'bitScore':
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
11 -b
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 #end if
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13 $summarize
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 #for $input in $inputs
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
15 ${input.input}
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
16 #end for
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
17 </command>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 <inputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 <repeat name="inputs" title="BLAST result">
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21 <param name="input" format="tabular" type="data" label="BLAST result"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 </repeat>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 <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
24 <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
25 <param name="score" type="select" label="Score by">
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 <option value="evalue">E-value</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 <option value="percentIdentity">Percent identity</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 <option value="bitScore">Bit score</option>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 </param>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
30 <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
31 </inputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33 <outputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 <data format="tabular" name="output"/>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35 </outputs>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 <help>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
39 **What it does**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
40
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41 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
42
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43 .. _KronaTools: http://krona.sourceforge.net
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
44
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
45 **Input**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
46
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
47 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
48
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
49 Example input (BLAST)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
51 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
52 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
53 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
54
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
55 **Output**
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
57 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
58
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
59 Example output (default)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
60
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
61 1 (query ID) 2 (tax ID) 3 (score)
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
62 read1 9606 94.34
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
63 read2 9616 32.17
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
64
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
65 Example output (summarized)::
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
66
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
67 1 (count) 2 (tax ID) 3 (score)
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
68 243 9606 94.34
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
69 17 9616 32.17
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
70
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
71 </help>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
72 <requirements>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
73 <requirement type="binary">ktClassifyBLAST</requirement>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
74 </requirements>
53258f6dddd3 Add tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
diff changeset
75 </tool>