annotate blast_reporting.xml @ 0:7db7ecc78ad6 draft

Uploaded
author damion
date Mon, 02 Mar 2015 20:46:00 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
1 <tool id="blast_reporting" name="BLAST Reporting" version="1.0.5">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
2 <description>BLAST search results reporting tool</description>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
3 <command interpreter="python"><![CDATA[
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
4 blast_reporting.py
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
5 $blastxml_file
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
6 $out_format
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
7 $tabular_file
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
8 $html_file
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
9 $selection_file:$selection_file.hid:$selection_file.dataset_id:$selection_file.id
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
10 $html_template
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
11 -f "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
12 #for $my_repeat in $filter_num
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
13 $my_repeat.filter_column:
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
14 #for $my_repeat2 in $my_repeat.constraint
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
15 $my_repeat2.filter_comparison $my_repeat2.filter_value,
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
16 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
17 ;
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
18 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
19 #for $my_repeat in $filter_text
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
20 $my_repeat.filter_column2:
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
21 #for $my_repeat2 in $my_repeat.constraint2
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
22 $my_repeat2.filter_comparison2 $my_repeat2.filter_value2.replace(',','|'),
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
23 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
24 ;
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
25 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
26 "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
27 #if len($bins)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
28 -b "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
29 #for $my_repeat in $bins
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
30 $my_repeat.bin_column:$my_repeat.group:$my_repeat.filter:$my_repeat.description;
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
31 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
32 "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
33 #end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
34 #if $drop_redundant_hits
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
35 -r
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
36 #end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
37 #if $column_labels
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
38 -l "${column_labels}"
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
39 #end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
40 #if len($fields)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
41 -c "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
42 #for $my_repeat in $fields
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
43 $my_repeat.field:$my_repeat.group:$my_repeat.sort:$my_repeat.label;
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
44 #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
45 "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
46 #end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
47 #if not str($row_limit) == "None"
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
48 -n "${row_limit}"
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
49 #end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
50 ###if $library_datasets
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
51 ## -B "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
52 ## #for $i, $dataset in enumerate($library_datasets)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
53 ## #$dataset.get_file_name()
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
54 ## $dataset.id
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
55 ## #end for
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
56 ## "
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
57 ###end if
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
58 ]]></command>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
59
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
60 <!-- target base="${GALAXY_DATA_MANAGER_DATA_PATH}">${dbkey}/seq/${path}</target -->
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
61
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
62 <inputs>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
63 <param name="blastxml_file" type="data" format="blastxml" label="BLAST results as XML"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
64
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
65 <repeat name="filter_num" title="Numeric Filter" min="0" max="4">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
66 <!-- TRIED conditional here, but it does not allow for <repeat> children. -->
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
67
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
68 <param name="filter_column" type="select" label="Col">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
69 <options from_data_table="blast_reporting_fields">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
70 <filter type="static_value" value="numeric" column="type" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
71 <filter type="sort_by" column="name"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
72 </options>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
73 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
74
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
75 <repeat name="constraint" title="Constraint" min="1" max="3">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
76 <param name="filter_comparison" type="select" label="Comparison">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
77 <option value="gte">&gt;= </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
78 <option value="gt">&gt;</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
79 <option value="lt">&lt; </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
80 <option value="lte">&lt;= </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
81 <option value="==">equal to </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
82 <option value="!=">not equal to </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
83 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
84
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
85 <param name="filter_value" type="text" value="" label="Value">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
86 <validator type="regex" message="Please input a number">([0-9]+|[0-9]*\.[0-9]+)</validator>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
87 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
88
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
89 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
90 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
91
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
92 <repeat name="filter_text" title="Text Filter" min="0" max="3">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
93 <param name="filter_column2" type="select" label="Column">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
94 <options from_data_table="blast_reporting_fields">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
95 <filter type="sort_by" column="name"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
96 <filter type="static_value" value="text" column="type" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
97 </options>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
98 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
99 <repeat name="constraint2" title="Constraint" min="1" max="6">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
100 <param name="filter_comparison2" type="select" label="Comparison">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
101 <option value="includes">has text</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
102 <option value="excludes">excludes text</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
103 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
104 <param name="filter_value2" type="text" size="25" label="Phrase(s), comma separated" value=""/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
105 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
106 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
107
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
108 <param name="drop_redundant_hits" type="boolean" checked="true" label="Throw out redundant hits" help="Keep only the best hit when query matches multiple locales in a subject sequence." />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
109
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
110 <param name="row_limit" type="integer" label="Row limit (per query)" help="Limit each query's results to this many rows. 0=unlimited." value="0" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
111
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
112 <param name="out_format" type="select" label="Basic Report Field Output" help="Use the field selectors below to add or customize fields that end up in the output HTML or tabular report. By default results are presented by query, with table data sorted by score, descending. Enter a preferred label in the text field to override the default field labeling.">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
113 <option value="std" selected="True">Standard 12 columns</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
114 <option value="std+seqs">Standard 12 columns + sequences</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
115 <option value="ext">Extended 24 columns</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
116 <option value="ext+">Extended 26 columns</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
117 <option value="custom">Only field selections below</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
118 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
119
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
120 <repeat name="fields" title="Field" min="0">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
121 <!-- acc, descr, score, p_cov, p_ident, -->
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
122 <param name="field" type="select" label="Include">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
123 <options from_data_table="blast_reporting_fields">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
124 <filter type="sort_by" column="name"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
125 <filter type="static_value" value="1" column="choose" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
126 </options>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
127 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
128 <param name="group" type="select" label="Group">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
129 <option value="column" selected="true">A column</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
130 <option value="hidden">A hidden column</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
131 <option value="table">A table section</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
132 <option value="section">A report section</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
133 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
134 <param name="sort" type="select" label="Sort">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
135 <option value="" selected="true">no sorting</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
136 <option value="desc">descend</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
137 <option value="asc">ascend</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
138 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
139
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
140 <param name="label" type="text" label="Customize label for this column or section" size="15" value=""/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
141 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
142
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
143 <!-- Disabled until Galaxy bug fixed for this.
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
144 <param name="library_datasets" type="library_data" label="Reference Bin file" help="Select one reference bin at a time from the popup window's Reference Bin library."/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
145 -->
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
146
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
147 <repeat name="bins" title="Reference Bin" min="0" max="5">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
148
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
149 <param name="bin_column" type="select" label="Sort by database bin match">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
150 <options from_data_table="fasta_reference_dbs"></options>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
151 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
152 <param name="group" type="select" label="Grouping">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
153 <option value="column" selected="true">A column</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
154 <option value="hidden">A hidden column</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
155 <option value="table">A table section</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
156 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
157 <param name="filter" type="select" label="Filtering">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
158 <option value="" selected="true">No filtering </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
159 <option value="include">keep only matches </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
160 <option value="exclude">Exclude matches </option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
161 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
162 <param name="description" type="boolean" checked="true" label="Show Description" help="Show description" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
163 </repeat>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
164
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
165 <param name="column_labels" type="select" label="Tabular Report Column Labels" help="">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
166 <option value="label" selected="True">Short name</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
167 <option value="field">Field name</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
168 <option value="">No labels</option>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
169 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
170
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
171 <param name="html_template" type="select" optional="true" label="HTML Report template">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
172 <options from_data_table="blast_reporting_templates"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
173 </param>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
174
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
175 </inputs>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
176 <outputs>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
177
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
178 <data format="tabular" name="tabular_file" label="Tabular report for data $blastxml_file.hid" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
179 <data format="html" name="html_file" label="HTML report for data $blastxml_file.hid">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
180 <filter>html_template != ""</filter>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
181 </data>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
182 <data format="tabular" name="selection_file" label="Sequence Selection List for data $blastxml_file.hid">
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
183 <filter>out_format != "std"</filter>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
184 </data>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
185 </outputs>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
186
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
187 <tests>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
188 <test><!-- Test taken from original BLAST to xml tool -->
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
189 <param name="blastxml_file" value="blastx_sample.xml"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
190 <output name="tabular_file" file="blastx_sample_converted.tabular"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
191 <param name="out_format" value="std"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
192 <param name="column_labels" value="" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
193 <param name="drop_redundant_hits" value="False"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
194 </test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
195
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
196 <test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
197 <param name="blastxml_file" value="blast_reporting_1.blastxml"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
198 <output name="tabular_file" file="blast_reporting_1a.tabular"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
199 <param name="out_format" value="std"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
200 <param name="column_labels" value="" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
201 <param name="drop_redundant_hits" value="True"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
202 </test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
203
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
204 <test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
205 <param name="blastxml_file" value="blast_reporting_1.blastxml"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
206 <output name="tabular_file" file="blast_reporting_1b.tabular"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
207 <param name="out_format" value="std"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
208 <param name="column_labels" value="" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
209 <param name="drop_redundant_hits" value="True"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
210
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
211 <param name="filter_num_0|filter_column" value="pident"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
212 <param name="filter_num_0|constraint_0|filter_comparison" value="gte"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
213 <param name="filter_num_0|constraint_0|filter_value" value="97"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
214
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
215 </test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
216
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
217 <test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
218 <param name="blastxml_file" value="blast_reporting_1.blastxml"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
219 <output name="tabular_file" file="blast_reporting_1c.tabular"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
220 <output name="selection_file" file="blast_reporting_1c1.tabular"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
221
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
222 <param name="out_format" value="ext+"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
223 <param name="column_labels" value="" />
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
224 <param name="drop_redundant_hits" value="True"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
225
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
226 <param name="filter_num_0|filter_column" value="pident"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
227 <param name="filter_num_0|constraint_0|filter_comparison" value="gte"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
228 <param name="filter_num_0|constraint_0|filter_value" value="97"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
229
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
230 <param name="fields_0|field" value="pident"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
231 <param name="fields_0|group" value="column"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
232 <param name="fields_0|sort" value="asc"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
233
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
234 <param name="column_labels" value="label"/>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
235
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
236 </test>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
237
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
238 </tests>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
239
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
240 <help><![CDATA[
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
241
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
242 .. class:: infomark
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
243
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
244 **What it does**
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
245
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
246 NCBI BLAST+ searches can output in a range of formats, but in the past only
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
247 the XML format included fields like sequence description.
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
248 This tool converts the BLAST XML report into 12, 24, 26 or custom column tabular
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
249 and HTML reports. This tool is loosely based on the ''BLAST XML to tabular'' tool
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
250 available in main toolshed. For the default 12 and 24 column reports, it should
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
251 produce the same output although whitespace differences may exist.
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
252
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
253 ====== ============= ============================================
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
254 Column NCBI name Description
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
255 ====== ============= ============================================
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
256 1 qseqid Query Seq-id (ID of your sequence)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
257 2 sseqid Subject Seq-id (ID of the database hit)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
258 3 pident Percentage of identical matches
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
259 4 length Alignment length
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
260 5 mismatch Number of mismatches
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
261 6 gapopen Number of gap openings
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
262 7 qstart Start of alignment in query
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
263 8 qend End of alignment in query
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
264 9 sstart Start of alignment in subject (database hit)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
265 10 send End of alignment in subject (database hit)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
266 11 evalue Expectation value (E-value)
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
267 12 bitscore Bit score
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
268 .
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
269 13 sallseqid All subject Seq-id(s), separated by a ';'
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
270 14 score Raw score
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
271 15 nident Number of identical matches
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
272 16 positive Number of positive-scoring matches
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
273 17 gaps Total number of gaps
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
274 18 ppos Percentage of positive-scoring matches
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
275 19 qframe Query frame
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
276 20 sframe Subject frame
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
277 21 qseq Aligned part of query sequence
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
278 22 sseq Aligned part of subject sequence
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
279 23 qlen Query sequence length
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
280 24 slen Subject sequence length
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
281 .
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
282 25 pcov Percentage coverage
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
283 26 sallseqdescr All subject Seq-descr(s), separated by a ','
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
284 ====== ============= ============================================
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
285
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
286 An option also exists to select particular columns for the output
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
287 report, and to cross-reference each result with one or more reference bins.l
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
288 A command line version can be used. Type blast_reporting.py -h for help.
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
289
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
290 **python blast_reporting.py in_file out_file out_format [options]**
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
291
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
292 .. class:: warningmark
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
293
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
294 As noted in the original BLAST XML to tabular tool, ''Be aware that the XML file (and thus the conversion) and the tabular output direct from BLAST+ may differ in the presence of XXXX masking on regions low complexity (columns 21 and 22), and thus also calculated figures like the percentage identity (column 3) and gap openings.''
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
295
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
296 **References**
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
297
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
298 If using this tool for publishing results, you may need to cite its origin in the BLAST XML to tabular tool:
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
299
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
300 Peter J.A. Cock, Björn A. Grüning, Konrad Paszkiewicz and Leighton Pritchard (2013).
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
301 Galaxy tools and workflows for sequence analysis with applications
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
302 in molecular plant pathology. PeerJ 1:e167
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
303 http://dx.doi.org/10.7717/peerj.167
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
304
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
305 ]]></help>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
306 <citations>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
307 <citation type="doi">10.7717/peerj.167</citation>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
308 </citations>
7db7ecc78ad6 Uploaded
damion
parents:
diff changeset
309 </tool>