Mercurial > repos > devteam > blast_datatypes
annotate README.rst @ 12:da92fef90117 draft
Uploaded v0.0.20 with new citation information
author | peterjc |
---|---|
date | Wed, 25 Feb 2015 10:50:44 -0500 |
parents | 236046d1d441 |
children | e96b515847dd |
rev | line source |
---|---|
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
1 Galaxy datatypes for NCBI BLAST+ suite |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
2 ====================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
3 |
11 | 4 These Galaxy datatypes are copyright 2010-2014 by Peter Cock (The James Hutton |
5 Institute, UK) and additional contributors including Edward Kirton, Nicola | |
6 Soranzo, and Bjoern Gruening. | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
7 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
8 See the licence text below. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
9 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
10 Note that these files (and the associated BLAST+ wrappers) were originally |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
11 distributed as part of the main Galaxy repository, but as of August 2012 moved |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
12 to the Galaxy Tool Shed as 'blast_datatypes' (and 'ncbi_blast_plus' for the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
13 wrappers). My thanks to Dannon Baker from the Galaxy development team for his |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
14 assistance with this. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
15 |
8
7ceb2ae30ff4
Uploaded v0.0.17, Add maskinfo-asn1 and maskinfo-asn1-binary sub-datatypes
peterjc
parents:
7
diff
changeset
|
16 It is available from the Galaxy Tool Shed at: |
7ceb2ae30ff4
Uploaded v0.0.17, Add maskinfo-asn1 and maskinfo-asn1-binary sub-datatypes
peterjc
parents:
7
diff
changeset
|
17 http://toolshed.g2.bx.psu.edu/view/devteam/blast_datatypes |
7ceb2ae30ff4
Uploaded v0.0.17, Add maskinfo-asn1 and maskinfo-asn1-binary sub-datatypes
peterjc
parents:
7
diff
changeset
|
18 |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
19 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
20 History |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
21 ======= |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
22 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
23 These versions numbers initially matched those for 'ncbi_blast_plus', but are |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
24 not used explicitly in the datatypes themselves. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
25 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
26 ======= ====================================================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
27 Version Changes |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
28 ------- ---------------------------------------------------------------------- |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
29 v0.0.11 - Final revision as part of the Galaxy main repository, and the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
30 first release via the Tool Shed |
11 | 31 v0.0.13 - Uses ``blast.py`` instead of ``xml.py`` to define the datatypes |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
32 v0.0.14 - Includes datatypes for protein and nucleotide BLAST databases |
10 | 33 (``blastdbp`` and ``blastdbn``, based on work by Edward Kirton) |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
34 v0.0.15 - Fixes a MetadataElement bug and includes more of the optional |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
35 BLAST database files (contribution from Nicola Soranzo) |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
36 v0.0.16 - Adopt standard MIT License. |
8
7ceb2ae30ff4
Uploaded v0.0.17, Add maskinfo-asn1 and maskinfo-asn1-binary sub-datatypes
peterjc
parents:
7
diff
changeset
|
37 - Use reStructuredText for this README file. |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
38 - Development moved to GitHub, https://github.com/peterjc/galaxy_blast |
7
a44a7a5456e1
Uploaded v0.0.16a, Nucleotide database definition aware of MegaBLAST index superheader
peterjc
parents:
6
diff
changeset
|
39 - Nucleotide database definition aware of MegaBLAST index superheader |
10 | 40 v0.0.17 - Add ``maskinfo-asn1`` and ``maskinfo-asn1-binary`` sub-datatypes |
11 | 41 (contribution from Nicola Soranzo) |
9
e36c60d13c94
Uploaded v0.0.18, tweak display_data for running tests
peterjc
parents:
8
diff
changeset
|
42 v0.0.18 - Add retries to BLAST XML merge code. |
e36c60d13c94
Uploaded v0.0.18, tweak display_data for running tests
peterjc
parents:
8
diff
changeset
|
43 - Modify display_data method to allow unit tests to function. |
12 | 44 v0.0.19 - Add ``blastdbd`` datatype for BLAST protein domain databases, for use |
10 | 45 with makeprofiledb and rpsblast (contribution from Bjoern Gruening). |
46 - Add ``pssm-asn1`` datatype for Position Specific Scoring Matrices | |
47 (PSSMs) stored in NCBI's "scoremat" ASN.1 format (usually named | |
12 | 48 as ``*.smp``), used as input files for makeprofiledb. |
49 v0.0.20 - Added "NCBI BLAST+ integrated into Galaxy" preprint citation. | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
50 ======= ====================================================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
51 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
52 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
53 Installation |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
54 ============ |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
55 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
56 Doing this automatically via the Galaxy Tool Shed is probably simplest. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
57 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
58 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
59 Manual Installation |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
60 =================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
61 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
62 Normally you would install this via the Galaxy ToolShed, which would move |
10 | 63 the provided ``blast.py`` file into a suitable location and process the |
64 ``datatypes_conf.xml`` entries to be combined with your local configuration. | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
65 |
10 | 66 However, if you really want to this should work for a manual install. First |
67 update the ``datatypes_conf.xml`` file in the Galaxy main folder by inserting | |
68 the contents of the ``<registration>`` and ``<sniffers>`` sections from the | |
69 small ``datatypes_conf.xml`` file provided in the tar-ball. | |
70 | |
71 For the ``<registration>`` section you would add several ``<datatype ... />`` | |
72 lines, one per new datatype:: | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
73 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
74 <datatype extension="blastxml" type="galaxy.datatypes.blast:BlastXml" mimetype="application/xml" display_in_upload="true"/> |
10 | 75 ... |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
76 |
10 | 77 Similarly, some of the new dataypes have ``<sniffer ... />`` lines used to |
78 automatically recognise the datatype when uploaded into Galaxy:: | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
79 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
80 <sniffer type="galaxy.datatypes.blast:BlastXml"/> |
10 | 81 ... |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
82 |
10 | 83 Also create the file ``lib/galaxy/datatypes/blast.py`` by moving, copying or linking |
84 the ``blast.py`` file provided in this tar-ball. Finally add ``import blast`` near | |
85 the start of file ``lib/galaxy/datatypes/registry.py`` (after the other import | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
86 lines). |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
87 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
88 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
89 Bug Reports |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
90 =========== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
91 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
92 You can file an issue here https://github.com/peterjc/galaxy_blast/issues or ask |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
93 us on the Galaxy development list http://lists.bx.psu.edu/listinfo/galaxy-dev |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
94 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
95 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
96 Developers |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
97 ========== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
98 |
10 | 99 These BLAST+ datatypes and associated tools were originally developed on the |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
100 following hg branch: http://bitbucket.org/peterjc/galaxy-central/src/tools |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
101 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
102 As of July 2013, development is continuing on a dedicated GitHub repository: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
103 https://github.com/peterjc/galaxy_blast |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
104 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
105 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use |
10 | 106 the following command from the ``blast_datatypes`` folder:: |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
107 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
108 $ tar -czf blast_datatypes.tar.gz README.rst datatypes_conf.xml blast.py |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
109 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
110 Check this worked:: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
111 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
112 $ tar -tzf blast_datatypes.tar.gz |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
113 README.rst |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
114 datatypes_conf.xml |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
115 blast.py |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
116 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
117 For development, rather than having a local ToolShed running, I currently |
10 | 118 use a symlink from ``lib/galaxy/datatypes/blast.py`` to the actual file as |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
119 described above. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
120 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
121 |
12 | 122 Citation |
123 ======== | |
124 | |
125 Please cite the following paper (currently available as a preprint): | |
126 | |
127 NCBI BLAST+ integrated into Galaxy. | |
128 P.J.A. Cock, J.M. Chilton, B. Gruening, J.E. Johnson, N. Soranzo | |
129 bioRxiv DOI: http://dx.doi.org/10.1101/014043 (preprint) | |
130 | |
131 | |
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
132 Licence (MIT) |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
133 ============= |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
134 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
135 Permission is hereby granted, free of charge, to any person obtaining a copy |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
136 of this software and associated documentation files (the "Software"), to deal |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
137 in the Software without restriction, including without limitation the rights |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
138 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
139 copies of the Software, and to permit persons to whom the Software is |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
140 furnished to do so, subject to the following conditions: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
141 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
142 The above copyright notice and this permission notice shall be included in |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
143 all copies or substantial portions of the Software. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
144 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
145 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
146 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
147 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
148 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
149 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
150 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
151 THE SOFTWARE. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
152 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
153 NOTE: This is the licence for the Galaxy BLAST datatypes **only**. BLAST+ |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
154 and associated data files are available and licenced separately. |