annotate classify_blast.xml @ 9:1b9c7c457fc1 draft default tip

Uploaded hidden warning output
author p.lucas
date Tue, 17 Jan 2023 13:16:01 +0000
parents 5581400c908e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
1 <tool id="classify_blast" name="Classify BLAST" version="1.0.0">
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
2 <description>results using KronaTools</description>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
3
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
4 <requirements>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
5 <requirement name="package" version="2.8.1">krona</requirement>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
6 </requirements>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
7
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
8 <command>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
9 ktClassifyBLAST
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
10 -o $output
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
11 -e $factor
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
12 $random
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
13 #if $score == 'percentIdentity':
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
14 -p
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
15 #elif $score == 'bitScore':
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
16 -b
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
17 #end if
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
18 $summarize
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
19 #for $input in $inputs
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
20 ${input.input}
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
21 #end for
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
22 </command>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
23
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
24 <inputs>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
25 <repeat name="inputs" title="BLAST result">
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
26 <param name="input" format="tabular" type="data" label="BLAST result"/>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
27 </repeat>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
28 <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)."/>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
29 <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"/>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
30 <param name="score" type="select" label="Score by">
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
31 <option value="evalue">E-value</option>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
32 <option value="percentIdentity">Percent identity</option>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
33 <option value="bitScore">Bit score</option>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
34 </param>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
35 <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"/>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
36 </inputs>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
37
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
38 <outputs>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
39 <data format="tabular" name="output"/>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
40 </outputs>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
41
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
42 <help>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
43
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
44 **What it does**
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
45
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
46 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.
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
47
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
48 .. _KronaTools: http://krona.sourceforge.net
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
49
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
50 **Input**
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
51
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
52 Tabular BLAST results containing gi numbers. If comment lines are present, queries with no hits will be assigned to taxon -1 (consistent with MEGAN).
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
53
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
54 Example input (BLAST)::
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
55
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
56 1 2 3 4 5 6 7 8 9 10 11 12
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
57 read1 gi|211853080|gb|EQ846228.1| 97.33 150 1 3 6 154 9518999 9519146 5e-64 252
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
58 read2 gi|211853080|gb|EQ846228.1| 96.69 151 0 5 6 154 9496147 9496294 2e-62 246
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
59
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
60 **Output**
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
61
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
62 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.
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
63
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
64 Example output (default)::
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
65
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
66 1 (query ID) 2 (tax ID) 3 (score)
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
67 read1 9606 94.34
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
68 read2 9616 32.17
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
69
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
70 Example output (summarized)::
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
71
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
72 1 (count) 2 (tax ID) 3 (score)
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
73 243 9606 94.34
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
74 17 9616 32.17
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
75
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
76 </help>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
77 <requirements>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
78 <requirement type="binary">ktClassifyBLAST</requirement>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
79 </requirements>
2d0679d0d8f7 Uploaded classify blast
p.lucas
parents:
diff changeset
80 </tool>