Mercurial > repos > dfornika > blast_report_basic

annotate blast_report_basic.xml @ 6:b8a3578b6445 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author dfornika
date Tue, 03 Mar 2020 05:33:55 +0000
parents 7223a2e98bf8
children 6650fe4db541
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
1 <tool id="blast_report_basic" name="BLAST report" version="0.1.0+galaxy0" >
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
2 <description>Produce an HTML table report of BLAST results</description>
1
a63f676fe808 Uploaded
dfornika
parents: 0
diff changeset
3 <command>
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
4 <![CDATA[
4
7223a2e98bf8 Uploaded
dfornika
parents: 2
diff changeset
5 python '${__tool_directory__}/blast_report.py'
6
b8a3578b6445 Uploaded
dfornika
parents: 4
diff changeset
6 --min-identity ${min_identity}
b8a3578b6445 Uploaded
dfornika
parents: 4
diff changeset
7 --filter-keywords '${filter_kws}'
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
8 #if str($bins) != "None"
6
b8a3578b6445 Uploaded
dfornika
parents: 4
diff changeset
9 -b '${bins}'
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
10 #end if
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
11 $discard_redundant
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
12 '${tabular_blast_report_input}'
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
13 '${__tool_directory__}/templates/template2.tmpl}'
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
14 '${out_html}'
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
15 '${out_tab}'
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
16 ]]>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
17 </command>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
18 <inputs>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
19 <param name="tabular_blast_report_input" type="data" format="tabular" label="Tabular BLAST results (extended 26 columns)"/>
6
b8a3578b6445 Uploaded
dfornika
parents: 4
diff changeset
20 <param name="min_identity" type="integer" min="90" max="100" value="97" label="Minimum percentage identity"/>
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
21 <param name="filter_kws" type="text" size="50" label="Comma-separated list of description keyword filters" value="bovine,clone,environmental,swine,uncultivated,uncultured,unidentified"/>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
22 <param name="bins" type="select" label="Database bins" multiple="true" display="checkboxes">
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
23 <options from_data_table="blast_reference_bins">
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
24 <validator type="no_options" message="No BLAST reference bins available" />
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
25 </options>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
26 </param>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
27 <param name="discard_redundant" type="boolean" truevalue="-r" falsevalue="" label="Throw out redundant hits?"/>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
28 </inputs>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
29 <outputs>
2
0dbaa4e68866 Uploaded
dfornika
parents: 1
diff changeset
30 <data name="out_html" format="html" label="$tool.name on data $tabular_blast_report_input.hid: report"/>
0dbaa4e68866 Uploaded
dfornika
parents: 1
diff changeset
31 <data name="out_tab" format="tabular" label="$tool.name on data $tabular_blast_report_input.hid: tabular results"/>
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
32 </outputs>
1
a63f676fe808 Uploaded
dfornika
parents: 0
diff changeset
33 <tests>
a63f676fe808 Uploaded
dfornika
parents: 0
diff changeset
34 </tests>
0
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
35 <help>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
36
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
37 .. class:: infomark
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
38
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
39 **What it does**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
40
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
41 This tool produces a HTML report for each query in a tabular BLAST file.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
42
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
43 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
44
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
45 **Tabular BLAST results**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
46
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
47 One or more query's BLAST results in extended 26 column tabular format.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
48
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
49 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
50
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
51 **Report template**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
52
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
53 The report template dictates the format of the HTML report.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
54 Note that changing the template from the standard "Top 20 hits shown, toggle remainder" to "Euzby results shown first" causes
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
55 the order of the results in the HTML report and the tabular BLAST results (if outputted) to be inconsistent with each other.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
56
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
57 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
58
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
59 **Minimum percentage identity**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
60
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
61 Filter by percentage identity. This filter is applied before the description keyword filters.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
62
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
63 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
64
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
65 **Comma-separated list of description keyword filters**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
66
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
67 Filter by description keywords. Do not include spaces (unless your keyword is two words). These are applied
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
68 after the percentage identity filter.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
69
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
70 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
71
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
72 **Database bins**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
73
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
74 Bin the results by accession number into "database bins."
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
75
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
76 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
77
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
78 **Throw out redundant hits?**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
79
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
80 Only the first hit for any accession number will be reported.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
81
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
82 ----
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
83
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
84 **Output tabular BLAST results?**
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
85
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
86 This option produces a tabular BLAST file with the same results as those shown in the report.
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
87
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
88 </help>
5dfd84907521 planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/blast_report_basic commit bc359460bb66db7946cc68ccbd47cd479624c4a1-dirty
dfornika
parents:
diff changeset
89 </tool>