annotate README.rst @ 11:01b38f20197e draft default tip

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