Mercurial > repos > devteam > ncbi_blast_plus
annotate tools/ncbi_blast_plus/ncbi_blast_plus.txt @ 5:393a7a35383c draft
Uploaded v0.0.14 adding local BLAST database support.
This *requires* the matching update to the blast_datatypes repository. This adds basic wrappers for makeblastdb and blastdbinfo.
This update includes work by Edward Kirton.
author | peterjc |
---|---|
date | Fri, 09 Nov 2012 06:53:55 -0500 |
parents | 9d5beacae92b |
children | a23b0627623c |
rev | line source |
---|---|
3
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
1 Galaxy wrappers for NCBI BLAST+ suite |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
2 ===================================== |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
3 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
4 These wrappers are copyright 2010-2012 by Peter Cock, The James Hutton Institute |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
6 See the licence text below. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
7 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
8 Currently tested with NCBI BLAST 2.2.26+ (i.e. version 2.2.26 of BLAST+), |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
9 and do not work with the NCBI 'legacy' BLAST suite (e.g. blastall). |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
10 |
4
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
11 Note that these wrappers (and the associated datetypes) were originally |
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
12 distributed as part of the main Galaxy repository, but as of August 2012 |
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
13 moved to the Galaxy Tool Shed as 'ncbi_blast_plus' (and 'blast_datatypes'). |
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
14 My thanks to Dannon Baker from the Galaxy development team for his assistance |
3
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
15 with this. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
16 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
17 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
18 Manual Installation |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
19 =================== |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
20 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
21 For those not using Galaxy's automated installation from the Tool Shed, put |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
22 the XML and Python files under tools/ncbi_blast_plus and add the XML files |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
23 to your tool_conf.xml as normal. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
24 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
25 You must tell Galaxy about any system level BLAST databases using configuration |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
26 files blastdb.loc (nucleotide databases like NT) and blastdb_p.loc (protein |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
27 databases like NR). |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
28 |
4
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
29 You will also need to install 'blast_datatypes' from the Tool Shed. This |
3
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
30 defines the BLAST XML file format ('blastxml'). |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
31 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
32 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
33 History |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
34 ======= |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
35 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
36 v0.0.11 - Final revision as part of the Galaxy main repository, and the |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
37 first release via the Tool Shed |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
38 v0.0.12 - Implements genetic code option for translation searches. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
39 - Changes <parallelism> to 1000 sequences at a time (to cope with |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
40 very large sets of queries where BLAST+ can become memory hungry) |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
41 - Include warning that BLAST+ with subject FASTA gives pairwise |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
42 e-values |
4
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
43 v0.0.13 - Use the new error handling options in Galaxy (the previously |
9d5beacae92b
Uploaded v0.0.13 which uses the recently added error handling. No longer bundles the hide_stderr.py script which is now redundant.
peterjc
parents:
3
diff
changeset
|
44 bundled hide_stderr.py script is no longer needed). |
5
393a7a35383c
Uploaded v0.0.14 adding local BLAST database support.
peterjc
parents:
4
diff
changeset
|
45 v0.0.14 - Support for makeblastdb and local BLAST databases in the history |
393a7a35383c
Uploaded v0.0.14 adding local BLAST database support.
peterjc
parents:
4
diff
changeset
|
46 (using work from Edward Kirton). |
3
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
47 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
48 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
49 Developers |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
50 ========== |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
51 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
52 This script and related tools are being developed on the following hg branch: |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
53 http://bitbucket.org/peterjc/galaxy-central/src/tools |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
54 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
55 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball I use |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
56 the following command from the Galaxy root folder: |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
57 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
58 $ ./tools/ncbi_blast_plus/make_ncbi_blast_plus.sh |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
59 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
60 This similifies ensuring a consistent set of files is bundled each time, |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
61 including all the relevant test files. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
62 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
63 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
64 Licence (MIT/BSD style) |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
65 ======================= |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
66 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
67 Permission to use, copy, modify, and distribute this software and its |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
68 documentation with or without modifications and for any purpose and |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
69 without fee is hereby granted, provided that any copyright notices |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
70 appear in all copies and that both those copyright notices and this |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
71 permission notice appear in supporting documentation, and that the |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
72 names of the contributors or copyright holders not be used in |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
73 advertising or publicity pertaining to distribution of the software |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
74 without specific prior permission. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
75 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
76 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
77 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
78 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
79 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
80 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
81 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
82 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
83 OR PERFORMANCE OF THIS SOFTWARE. |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
84 |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
85 NOTE: This is the licence for the Galaxy Wrapper only. BLAST+ and |
643338ac83c0
Uploaded v0.0.12b, same code but moving folders around to match all my other tools and make future development simpler.
peterjc
parents:
diff
changeset
|
86 associated data files are available and licenced separately. |