Mercurial > repos > peterjc > blast_rbh
annotate tools/blast_rbh/README.rst @ 20:e8f8c580bcca draft
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
author | peterjc |
---|---|
date | Fri, 15 May 2015 05:47:40 -0400 |
parents | f3ec931988fd |
children | b41f8c43705e |
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 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
22 Please cite the following paper (currently available as a preprint): |
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 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
26 bioRxiv DOI: http://dx.doi.org/10.1101/014043 (preprint) |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
27 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
28 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
|
29 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
30 BLAST+: architecture and applications. |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
31 C. Camacho et al. BMC Bioinformatics 2009, 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
|
32 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
|
33 |
f3ec931988fd
Uploaded 0.1.6c with the preprint citation (forgot to update source folder before making tar ball).
peterjc
parents:
17
diff
changeset
|
34 |
0 | 35 Automated Installation |
36 ====================== | |
37 | |
38 Installation via the Galaxy Tool Shed should take care of the Galaxy side of | |
39 things, including the dependency the NCBI BLAST+ binaries. | |
40 | |
41 | |
42 Manual Installation | |
43 =================== | |
44 | |
45 There are just two files to install: | |
46 | |
47 - ``blast_rbh.py`` (the Python script) | |
48 - ``blast_rbh.xml`` (the Galaxy tool definition) | |
49 | |
50 The suggested location is in a ``tools/blast_rbh/`` folder. You will then | |
51 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool | |
52 by adding the line:: | |
53 | |
54 <tool file="blast_rbh/blast_rbh.xml" /> | |
55 | |
13 | 56 If you want to run the functional tests, copy the sample test files under |
57 sample test files under Galaxy's ``test-data/`` directory. Then:: | |
0 | 58 |
13 | 59 ./run_tests.sh -id blast_reciprocal_best_hits |
0 | 60 |
61 You will need to have the NCBI BLAST+ binaries installed and on the ``$PATH``. | |
62 | |
63 | |
64 History | |
65 ======= | |
66 | |
67 ======= ====================================================================== | |
68 Version Changes | |
69 ------- ---------------------------------------------------------------------- | |
10 | 70 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
|
71 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
|
72 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
|
73 - Tool definition now embeds citation information. |
10 | 74 - Fixed Tool Shed dependency definition. |
12 | 75 v0.1.3 - Option to make FASTA files non-redundant (via Biopython dependency). |
76 - Avoid extra database and BLAST search in self-comparison mode. | |
13 | 77 v0.1.4 - Check for duplicate FASTA identifiers (workaround for makeblastdb |
78 not treating this as an error, leading to confusing RBH output). | |
79 v0.1.5 - Clarify documentation for using the Python script outside Galaxy. | |
80 - Updated to depend on NCBI BLAST+ 2.2.30 via ToolShed install. | |
15 | 81 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
|
82 - 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
|
83 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
|
84 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). |
0 | 85 ======= ====================================================================== |
86 | |
87 | |
88 Developers | |
89 ========== | |
90 | |
91 This tool is developed on the following GitHub repository: | |
92 https://github.com/peterjc/galaxy_blast/tree/master/tools/blast_rbh | |
93 | |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
94 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
|
95 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
|
96 ``~/.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
|
97 |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
98 $ planemo shed_upload --shed_target testtoolshed --check_diff ~/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
|
99 ... |
0 | 100 |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
101 or:: |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
102 |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
103 $ planemo shed_upload --shed_target toolshed --check_diff ~/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
|
104 ... |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
105 |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
106 To just build and check the tar ball, use:: |
0 | 107 |
20
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
108 $ 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
|
109 ... |
e8f8c580bcca
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blast_rbh commit 05c2a834609f1fd02372c4f9b0a0733680fe9675-dirty
peterjc
parents:
18
diff
changeset
|
110 $ 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
|
111 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
|
112 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
|
113 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
|
114 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
|
115 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
|
116 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
|
117 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
|
118 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
|
119 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
|
120 test-data/rbh_tblastx_rhodopsin_nucs_vs_three_human_mRNA.tabular |
0 | 121 test-data/rhodopsin_nucs.fasta |
1 | 122 test-data/rhodopsin_proteins.fasta |
0 | 123 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
|
124 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
|
125 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
|
126 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
|
127 tools/blast_rbh/tool_dependencies.xml |
0 | 128 |
129 | |
130 Licence (MIT) | |
131 ============= | |
132 | |
133 Permission is hereby granted, free of charge, to any person obtaining a copy | |
134 of this software and associated documentation files (the "Software"), to deal | |
135 in the Software without restriction, including without limitation the rights | |
136 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
137 copies of the Software, and to permit persons to whom the Software is | |
138 furnished to do so, subject to the following conditions: | |
139 | |
140 The above copyright notice and this permission notice shall be included in | |
141 all copies or substantial portions of the Software. | |
142 | |
143 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
144 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
145 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
146 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
147 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
148 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
149 THE SOFTWARE. |