annotate blast2html.xml @ 1:9272a08cb8fe

update v2
author Jan Kanis <jan.code@jankanis.nl>
date Thu, 23 Jul 2015 09:46:31 +0200
parents d448fe1df4a1
children b39e07d89fda
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
9272a08cb8fe update v2
Jan Kanis <jan.code@jankanis.nl>
parents: 0
diff changeset
1 <tool id="blast2html_test" name="blast2html_test" version="0.0.18">
0
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
2
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
3 <description>Convert BLAST XML to HTML</description>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
4
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
5 <requirements>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
6 <requirement name="package" version="0.2">blast2html_venv</requirement>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
7 </requirements>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
8
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
9 <command interpreter="python">blast2html.py -i "${input}" -o "${output}" --db-config-dir "${GALAXY_DATA_INDEX_DIR}"</command>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
10
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
11 <stdio>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
12 <!-- Any exit code other than 0 is an error -->
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
13 <exit_code range="1:" />
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
14 <exit_code range=":-1" />
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
15 </stdio>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
16
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
17 <inputs>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
18 <param format="blastxml" name="input" type="data" label="Source file"/>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
19 </inputs>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
20
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
21 <outputs>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
22 <data format="html" name="output" />
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
23 </outputs>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
24
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
25 <help>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
26 Blast2html: Blast XML to HTML conversion tool
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
27 =============================================
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
28
1
9272a08cb8fe update v2
Jan Kanis <jan.code@jankanis.nl>
parents: 0
diff changeset
29 This is the help section in blast2html.xml
9272a08cb8fe update v2
Jan Kanis <jan.code@jankanis.nl>
parents: 0
diff changeset
30
0
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
31 This tool accepts Blast XML as input, and creates an HTML page with a human readable version of the result. The output includes graphical displays of where a sequence matches a target and metrics on the quality of the match.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
32
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
33 Example output:
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
34
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
35 .. image:: blast2html_screenshot1.png
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
36 :alt: Screenshot of sample output
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
37 :align: center
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
38
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
39 The output format is based on the graphical summary pages on the `NCBI Blast website`_. But as the code for generating such pages is not available we implemented our own clone.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
40
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
41 .. _`NCBI Blast website`: http://blast.ncbi.nlm.nih.gov/Blast.cgi
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
42
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
43
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
44 Galaxy configuration
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
45 --------------------
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
46
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
47 This tool generates an HTML page from Blast XML input. It can be used as a stand-alone command line tool, but it is meant to be used in workflows in Galaxy_. To use this tool in Galaxy some configuration may be required.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
48
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
49 By default Galaxy strips a lot of style information from HTML files before showing them on the screen. The results of this tool will still be somewhat useful but they will be a lot uglier without the styles. You can still download the original generated HTML of course. If you want to view the full result within Galaxy you need to disable this stripping of style information by adding the following line to your Galaxy's ``galaxy.ini``::
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
50
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
51 sanitize_all_html = False
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
52
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
53 In order to generate links to a gene bank in the result, you will need to tell blast2html what gene bank to use. If you do not configure a gene bank the result will contain links to the NCBI gene bank, and as a name for the gene bank the generic "Gene Bank" is used. These links will only work if the database you are using uses the same accession codes as the NCBI gene bank. To show links to a different gene bank this needs to be configured in Galaxy.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
54
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
55 As at the moment this tool was built Galaxy did not have a good way to specify such configuration directives to tools, we use a slightly ugly solution. The gene bank configuration are added to the NCBI BLAST+ database definition files in Galaxy's ``tool-data`` directory. This directory should contain some files named ``blastdb.loc``, ``blastdb_p.loc``, ``blastdb_d.loc`` etc. that define the databases that the NCBI BLAST+ tool knows about. For BLAST, these files contain three columns of tab-separated data that define the databases. The normal format is::
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
56
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
57 &lt;unique_id&gt; &lt;database_caption&gt; &lt;base_name_path&gt;
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
58
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
59 with tabs separating the three components. For blast2html we extend this format with two columns that contain a human-readable gene bank name, and a link template. So each row then contains these tab-separated items::
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
60
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
61 &lt;unique_id&gt; &lt;database_caption&gt; &lt;base_name_path&gt; &lt;genebank_name&gt; &lt;genebank_link_template&gt;
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
62
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
63 NCBI Blast+ will ignore the extra fields in the file.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
64
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
65 So, for example, for a database named ``nt`` with path ``/depot/data2/galaxy/blastdb/nt/nt.chunk`` that uses NCBI nucleontide database accession codes you can use the following definition line::
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
66
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
67 nt_02_Dec_2009 nt 02 Dec 2009 /depot/data2/galaxy/blastdb/nt/nt.chunk NCBI Gene Bank http://www.ncbi.nlm.nih.gov/nucleotide/{accession}?report=genbank&amp;log$=nuclalign
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
68
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
69 The syntax for the link template is the same as that used by the ``--genelink-template`` command line option (see next section): It can contain the following replacement elements: ``{id[N]}``, ``{fullid}``, ``{defline[N]}``, ``{fulldefline}``, ``{accession}``, where ``N`` is a number. ``id[N]`` and ``defline[N]`` will be replaced by the Nth element of the id or defline, where '``|``' is the field separator.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
70
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
71
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
72 .. _Galaxy: https://www.galaxyproject.org/
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
73
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
74
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
75 Command line usage
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
76 ------------------
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
77
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
78 ::
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
79
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
80 usage: ./blast2html.py [-i] INPUT [-o OUTPUT] [--genelink-template URL_TEMPLATE] [--dbname DBNAME]
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
81
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
82 Convert a BLAST XML result into a nicely readable html page
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
83
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
84 positional arguments:
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
85 INPUT The input Blast XML file, same as -i/--input
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
86
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
87 optional arguments:
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
88 -h, --help show this help message and exit
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
89 -i INPUT, --input INPUT
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
90 The input Blast XML file
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
91 -o OUTPUT, --output OUTPUT
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
92 The output html file
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
93 --template TEMPLATE The template file to use. Defaults to
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
94 blast_html.html.jinja
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
95 --dbname DBNAME The link text to use for external links to a gene bank
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
96 database. Defaults to 'Gene Bank'
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
97 --genelink-template URL_TEMPLATE
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
98 A link template to link hits to a gene bank webpage.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
99 The template string is a Python format string. It can
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
100 contain the following replacement elements: {id[N]},
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
101 {fullid}, {defline[N]}, {fulldefline}, {accession},
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
102 where N is a number. id[N] and defline[N] will be
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
103 replaced by the Nth element of the id or defline,
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
104 where '|' is the field separator. The default is 'http
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
105 ://www.ncbi.nlm.nih.gov/nucleotide/{accession}?report=
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
106 genbank&amp;log$=nuclalign', which is a link to the NCBI
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
107 nucleotide database.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
108 --db-config-dir DB_CONFIG_DIR
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
109 The directory where databases are configured in
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
110 blastdb*.loc files. These files are consulted for
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
111 creating a gene bank link. The files should conform to
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
112 the format that Galaxy's BLAST expect, i.e. tab-
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
113 separated tables (with lines starting with '#'
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
114 ignored), with two extra fields, for a total of five
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
115 fields per line instead of three.. The third field of
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
116 each line should be a database path as used by BLAST.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
117 The fourth field is the human readable database name,
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
118 and the fifth a template link to the gene bank
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
119 conforming to the syntax for the --genelink-template
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
120 option. Entries in these config files override links
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
121 specified using --genelink-template and --dbname.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
122
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
123
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
124 Authorship
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
125 ----------
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
126
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
127 This tool was created and published by `The Hyve B.V.`_ open source bioinformatics solutions.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
128
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
129 .. image:: thehyve_logo.png
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
130 :alt: The Hyve
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
131 :align: center
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
132 :target: http://thehyve.nl
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
133
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
134 .. _`The Hyve B.V.`: http://thehyve.nl/
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
135
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
136
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
137 Licensing information
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
138 ---------------------
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
139
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
140 Blast2html is free software: you can redistribute it and/or modify
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
141 it under the terms of the GNU General Public License as published by
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
142 the Free Software Foundation, either version 3 of the License, or
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
143 (at your option) any later version.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
144
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
145 This program is distributed in the hope that it will be useful,
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
146 but WITHOUT ANY WARRANTY; without even the implied warranty of
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
147 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
148 GNU General Public License for more details.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
149
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
150 You should have received a copy of the GNU General Public License
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
151 along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
152 </help>
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
153
Jan Kanis <jan.code@jankanis.nl>
parents:
diff changeset
154 </tool>