Mercurial > repos > peterjc > blast_rbh
annotate tools/blast_rbh/README.rst @ 21:b41f8c43705e draft
v0.1.7 - Updated citation & misc internal changes
author | peterjc |
---|---|
date | Fri, 04 Sep 2015 07:05:56 -0400 |
parents | e8f8c580bcca |
children | 75ab3e2cfa0e |
rev | line source |
---|---|
13 | 1 Find BLAST Reciprocal Best Hits (RBH), with Galaxy wrapper |
2 ========================================================== | |
0 | 3 |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
4 This tool is copyright 2011-2015 by Peter Cock, The James Hutton Institute |
0 | 5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
6 See the licence text below. | |
7 | |
8 This tool is a short Python script to run reciprocal BLAST searches on a | |
13 | 9 pair of sequence files, and extract the reciprocal best hits. The script |
10 ``blast_rbh.py`` can be used directly (without Galaxy) as long as NCBI | |
11 BLAST+ is installed. | |
0 | 12 |
13 | 13 It comes with an optional Galaxy tool definition file ``blast_rbh.xml`` |
14 allowing the Python script to be run from within Galaxy. It is available | |
15 from the Galaxy Tool Shed at: | |
12 | 16 http://toolshed.g2.bx.psu.edu/view/peterjc/blast_rbh |
0 | 17 |
18 | |
18
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
19 Citation |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
20 ======== |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
21 |
21 | 22 Please cite the following paper: |
18
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
23 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
24 NCBI BLAST+ integrated into Galaxy. |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
25 P.J.A. Cock, J.M. Chilton, B. Gruening, J.E. Johnson, N. Soranzo |
21 | 26 *GigaScience* 2015, 4:39 |
27 DOI: http://dx.doi.org/10.1186/s13742-015-0080-7 | |
18
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
28 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
29 You should also cite the NCBI BLAST+ tools: |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
30 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
31 BLAST+: architecture and applications. |
21 | 32 C. Camacho et al. *BMC Bioinformatics* 2009, 10:421. |
18
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
33 DOI: http://dx.doi.org/10.1186/1471-2105-10-421 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
34 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
35 |
0 | 36 Automated Installation |
37 ====================== | |
38 | |
39 Installation via the Galaxy Tool Shed should take care of the Galaxy side of | |
40 things, including the dependency the NCBI BLAST+ binaries. | |
41 | |
42 | |
43 Manual Installation | |
44 =================== | |
45 | |
46 There are just two files to install: | |
47 | |
48 - ``blast_rbh.py`` (the Python script) | |
49 - ``blast_rbh.xml`` (the Galaxy tool definition) | |
50 | |
51 The suggested location is in a ``tools/blast_rbh/`` folder. You will then | |
52 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool | |
53 by adding the line:: | |
54 | |
55 <tool file="blast_rbh/blast_rbh.xml" /> | |
56 | |
13 | 57 If you want to run the functional tests, copy the sample test files under |
58 sample test files under Galaxy's ``test-data/`` directory. Then:: | |
0 | 59 |
13 | 60 ./run_tests.sh -id blast_reciprocal_best_hits |
0 | 61 |
62 You will need to have the NCBI BLAST+ binaries installed and on the ``$PATH``. | |
63 | |
64 | |
65 History | |
66 ======= | |
67 | |
68 ======= ====================================================================== | |
69 Version Changes | |
70 ------- ---------------------------------------------------------------------- | |
10 | 71 v0.1.0 - Initial Test Tool Shed release, targetting NCBI BLAST+ 2.2.29 |
8
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
6
diff
changeset
|
72 v0.1.1 - Supports self-comparison, sometimes useful for spotting duplicates. |
d3eb5cda7270
Uploaded v0.1.2, self comparison and easier command line API
peterjc
parents:
6
diff
changeset
|
73 v0.1.2 - Using optparse for command line API. |
11
4733e4ea4dab
Uploaded v0.1.2c, same defaults in blast_rbh.py as blast_rbh.xml
peterjc
parents:
10
diff
changeset
|
74 - Tool definition now embeds citation information. |
10 | 75 - Fixed Tool Shed dependency definition. |
12 | 76 v0.1.3 - Option to make FASTA files non-redundant (via Biopython dependency). |
77 - Avoid extra database and BLAST search in self-comparison mode. | |
13 | 78 v0.1.4 - Check for duplicate FASTA identifiers (workaround for makeblastdb |
79 not treating this as an error, leading to confusing RBH output). | |
80 v0.1.5 - Clarify documentation for using the Python script outside Galaxy. | |
81 - Updated to depend on NCBI BLAST+ 2.2.30 via ToolShed install. | |
15 | 82 v0.1.6 - Offer the new blastp-fast task added in BLAST+ 2.2.30. |
18
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
83 - Added "NCBI BLAST+ integrated into Galaxy" preprint citation. |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
84 v0.1.7 - Reorder XML elements (internal change only). |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
85 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). |
21 | 86 - Updated citation information with GigaScience paper. |
0 | 87 ======= ====================================================================== |
88 | |
89 | |
90 Developers | |
91 ========== | |
92 | |
93 This tool is developed on the following GitHub repository: | |
94 https://github.com/peterjc/galaxy_blast/tree/master/tools/blast_rbh | |
95 | |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
96 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
97 Planemo commands (which requires you have set your Tool Shed access details in |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
98 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
99 |
21 | 100 $ planemo shed_update --shed_target testtoolshed --check_diff ~/repositories/galaxy_blast/tools/blast_rbh/ |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
101 ... |
0 | 102 |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
103 or:: |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
104 |
21 | 105 $ planemo shed_update --shed_target toolshed --check_diff ~/repositories/galaxy_blast/tools/blast_rbh/ |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
106 ... |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
107 |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
108 To just build and check the tar ball, use:: |
0 | 109 |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
110 $ planemo shed_upload --tar_only ~/repositories/galaxy_blast/tools/blast_rbh/ |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
111 ... |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
112 $ tar -tzf shed_upload.tar.gz |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
113 test-data/four_human_proteins.fasta |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
114 test-data/k12_edited_proteins.fasta |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
115 test-data/k12_ten_proteins.fasta |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
116 test-data/rbh_blastn_three_human_mRNA_vs_rhodopsin_nucs.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
117 test-data/rbh_blastp_four_human_vs_rhodopsin_proteins.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
118 test-data/rbh_blastp_k12.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
119 test-data/rbh_blastp_k12_self.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
120 test-data/rbh_megablast_rhodopsin_nucs_vs_three_human_mRNA.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
121 test-data/rbh_none.tabular |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
122 test-data/rbh_tblastx_rhodopsin_nucs_vs_three_human_mRNA.tabular |
0 | 123 test-data/rhodopsin_nucs.fasta |
1 | 124 test-data/rhodopsin_proteins.fasta |
0 | 125 test-data/three_human_mRNA.fasta |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
126 tools/blast_rbh/README.rst |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
127 tools/blast_rbh/blast_rbh.py |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
128 tools/blast_rbh/blast_rbh.xml |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
129 tools/blast_rbh/tool_dependencies.xml |
0 | 130 |
131 | |
132 Licence (MIT) | |
133 ============= | |
134 | |
135 Permission is hereby granted, free of charge, to any person obtaining a copy | |
136 of this software and associated documentation files (the "Software"), to deal | |
137 in the Software without restriction, including without limitation the rights | |
138 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
139 copies of the Software, and to permit persons to whom the Software is | |
140 furnished to do so, subject to the following conditions: | |
141 | |
142 The above copyright notice and this permission notice shall be included in | |
143 all copies or substantial portions of the Software. | |
144 | |
145 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
146 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
147 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
148 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
149 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
150 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
151 THE SOFTWARE. |