comparison tools/ncbi_blast_plus/README.rst @ 20:3034ce97dd33 draft

Uploaded v0.1.08, can search multiple local databases, fixes a pipe problem in blastdbcmd, and minor internal changes.
author peterjc
date Mon, 07 Nov 2016 11:31:37 -0500
parents 7f3c448e119b
children 7538e2bfcd41
comparison
equal deleted inserted replaced
19:7f3c448e119b 20:3034ce97dd33
1 Galaxy wrappers for NCBI BLAST+ suite 1 Galaxy wrappers for NCBI BLAST+ suite
2 ===================================== 2 =====================================
3 3
4 These wrappers are copyright 2010-2014 by Peter Cock (The James Hutton Institute, 4 These wrappers are copyright 2010-2016 by Peter Cock (The James Hutton Institute,
5 UK) and additional contributors including Edward Kirton, John Chilton, 5 UK) and additional contributors including Edward Kirton, John Chilton,
6 Nicola Soranzo, Jim Johnson, and Bjoern Gruening. 6 Nicola Soranzo, Jim Johnson, and Bjoern Gruening.
7 7
8 See the licence text below. 8 See the licence text below.
9 9
10 Currently tested with NCBI BLAST 2.2.30+ (i.e. version 2.2.30 of BLAST+), 10 Currently tested with NCBI BLAST+ 2.2.31, and does not work with the NCBI
11 and does not work with the NCBI 'legacy' BLAST suite (e.g. ``blastall``). 11 'legacy' BLAST suite (e.g. ``blastall``).
12 12
13 Note that these wrappers (and the associated datatypes) were originally 13 Note that these wrappers (and the associated datatypes) were originally
14 distributed as part of the main Galaxy repository, but as of August 2012 14 distributed as part of the main Galaxy repository, but as of August 2012
15 moved to the Galaxy Tool Shed as ``ncbi_blast_plus`` (and ``blast_datatypes``). 15 moved to the Galaxy Tool Shed as ``ncbi_blast_plus`` (and ``blast_datatypes``).
16 My thanks to Dannon Baker from the Galaxy development team for his assistance 16 My thanks to Dannon Baker from the Galaxy development team for his assistance
116 ``$GALAXY_SLOTS`` environment variable. This should be set automatically by 116 ``$GALAXY_SLOTS`` environment variable. This should be set automatically by
117 Galaxy via your job runner settings, which allows you to (for example) allocate 117 Galaxy via your job runner settings, which allows you to (for example) allocate
118 four cores to each BLAST job. 118 four cores to each BLAST job.
119 119
120 In addition, the BLAST+ wrappers also support high level parallelism by task 120 In addition, the BLAST+ wrappers also support high level parallelism by task
121 splitting if ``use_tasked_jobs = True`` is enabled in your ``universe_wsgi.ini`` 121 splitting if ``use_tasked_jobs = True`` is enabled in the ``config/galaxy.ini``
122 configuration file. Essentially, the FASTA input query files are broken up into 122 configuration file (previously ``universe_wsgi.ini`` on older versions of
123 Galaxy). Essentially, the FASTA input query files are broken up into
123 batches of 1000 sequences, a separate BLAST child job is run for each chunk, 124 batches of 1000 sequences, a separate BLAST child job is run for each chunk,
124 and then the BLAST output files are merged (in order). This is transparent 125 and then the BLAST output files are merged (in order). This is transparent
125 for the end user. 126 for the end user.
126 127
127 History 128 History
225 - Tests updated for BLAST+ 2.2.31 instead of BLAST+ 2.2.30. 226 - Tests updated for BLAST+ 2.2.31 instead of BLAST+ 2.2.30.
226 v0.1.07 - Re-enabled some ``*.loc`` file tests (these had not been supported 227 v0.1.07 - Re-enabled some ``*.loc`` file tests (these had not been supported
227 on the Tool Shed test framework, but that is not currently in use). 228 on the Tool Shed test framework, but that is not currently in use).
228 - Fixed macro problem with version field in blastxml_to_tabular.xml 229 - Fixed macro problem with version field in blastxml_to_tabular.xml
229 (contribution from Bjoern Gruening and Daniel Blankenberg). 230 (contribution from Bjoern Gruening and Daniel Blankenberg).
231 v0.1.08 - Allow searching against multiple locally installed databases
232 (contribution from Gildas Le Corguillé and Emma Prudent).
233 - Minor XML and Python style changes (internal change only).
234 - Set ``allow_duplicate_entries="False"`` in sample configuration file
235 ``tool_data_table_conf.xml``.
236 - Fix identifers with pipes in ``blastdbcmd`` wrapper (Devon Ryan).
230 ======= ====================================================================== 237 ======= ======================================================================
231 238
232 239
233 Bug Reports 240 Bug Reports
234 =========== 241 ===========