Mercurial > repos > peterjc > blastxml_to_top_descr
annotate tools/blastxml_to_top_descr/README.rst @ 29:dcf6b7390551 draft default tip
"planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 3ac00a9f99a93cbc8a6c136a302e7fbb17da8f71-dirty"
| author | peterjc |
|---|---|
| date | Thu, 10 Sep 2020 14:00:38 +0000 |
| parents | c0c0a615d7cc |
| children |
| rev | line source |
|---|---|
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
1 OBGalaxy tool to extract top BLAST hit descriptions from BLAST XML |
|
17
ccf0a59e8537
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 39737c01a51469d0cf9920273de6c151ba84048d-dirty
peterjc
parents:
15
diff
changeset
|
2 ================================================================== |
| 11 | 3 |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
4 This tool is copyright 2012-2015 by Peter Cock, The James Hutton Institute |
| 11 | 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 parse a BLAST XML file, and extract the | |
| 9 identifiers with description for the top matches (by default the top 3), and | |
| 10 output these as a simple tabular file along with the query identifiers. | |
| 11 | |
| 12 It is available from the Galaxy Tool Shed at: | |
| 13 http://toolshed.g2.bx.psu.edu/view/peterjc/blastxml_to_top_descr | |
| 14 | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
15 This requires the ``blast_datatypes`` repository from the Galaxy Tool Shed |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
16 to provide the ``blastxml`` file format definition. |
| 11 | 17 |
| 18 | |
| 19 Automated Installation | |
| 20 ====================== | |
| 21 | |
| 22 This should be straightforward, Galaxy should automatically install the | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
23 ``blast_datatypes`` dependency. |
| 11 | 24 |
| 25 | |
| 26 Manual Installation | |
| 27 =================== | |
| 28 | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
29 If you haven't done so before, first install the ``blast_datatypes`` repository. |
| 11 | 30 |
| 31 There are just two files to install (if doing this manually): | |
| 32 | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
33 - ``blastxml_to_top_descr.py`` (the Python script) |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
34 - ``blastxml_to_top_descr.xml`` (the Galaxy tool definition) |
| 11 | 35 |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
36 The suggested location is in the Galaxy folder ``tools/ncbi_blast_plus/`` |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
37 next to the NCBI BLAST+ tool wrappers. |
| 11 | 38 |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
39 You will also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer |
| 11 | 40 the tool. e.g. next to the NCBI BLAST+ tools. Simply add the line:: |
| 41 | |
| 42 <tool file="ncbi_blast_plus/blastxml_to_top_descr.xml" /> | |
| 43 | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
44 If you wish to run the unit tests, alsomove/copy the ``test-data/`` files |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
45 under Galaxy's ``test-data/`` folder. Then:: |
| 11 | 46 |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
47 $ sh run_tests.sh -id blastxml_to_top_descr |
| 11 | 48 |
| 49 | |
| 50 History | |
| 51 ======= | |
| 52 | |
| 53 ======= ====================================================================== | |
| 54 Version Changes | |
| 55 ------- ---------------------------------------------------------------------- | |
| 56 v0.0.1 - Initial version. | |
| 57 v0.0.2 - Since BLAST+ was moved out of the Galaxy core, now have a dependency | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
58 on the ``blast_datatypes`` repository in the Tool Shed. |
| 11 | 59 v0.0.3 - Include the test files required to run the unit tests |
| 60 v0.0.4 - Quote filenames in case they contain spaces (internal change) | |
| 61 v0.0.5 - Include number of queries with BLAST matches in stdout (peek text) | |
| 62 v0.0.6 - Check for errors via the script's return code (internal change) | |
| 63 v0.0.7 - Link to Tool Shed added to help text and this documentation. | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
64 - Tweak dependency on ``blast_datatypes`` to also work on Test Tool Shed |
| 11 | 65 - Adopt standard MIT License. |
| 66 v0.0.8 - Development moved to GitHub, https://github.com/peterjc/galaxy_blast | |
| 67 v0.0.9 - Updated citation information (Cock et al. 2013). | |
| 68 v0.0.10 - Update help text to mention BLAST+ 2.2.28 can produce tabular files | |
| 69 including the description/title (via the salltitles field). | |
| 70 v0.1.0 - Switch to using an optparse based API for Python script internally. | |
| 71 - Support BLAST XML with multiple ``<Iteration>`` blocks per query. | |
| 72 - Support the default 25 column extended tabular BLAST output. | |
| 13 | 73 v0.1.1 - Embed citation information in the tool XML (new Galaxy feature). |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
74 v0.1.2 - Reorder XML elements (internal change only). |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
75 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). |
|
18
5737e2e7179a
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 21f6d9932d322034e4cea5fee23b24bf0b1e1e85-dirty
peterjc
parents:
17
diff
changeset
|
76 - Use ``<command detect_errors="aggressive">`` (internal change only). |
|
5737e2e7179a
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 21f6d9932d322034e4cea5fee23b24bf0b1e1e85-dirty
peterjc
parents:
17
diff
changeset
|
77 - Single quote command line arguments (internal change only). |
|
19
a89d62b8a239
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit b09e12603b1264688a023dd5111c946c01af9e59-dirty
peterjc
parents:
18
diff
changeset
|
78 - Python 3 compatible syntax. |
| 11 | 79 ======= ====================================================================== |
| 80 | |
| 81 | |
| 82 Bug Reports | |
| 83 =========== | |
| 84 | |
| 85 You can file an issue here https://github.com/peterjc/galaxy_blast/issues or ask | |
| 86 us on the Galaxy development list http://lists.bx.psu.edu/listinfo/galaxy-dev | |
| 87 | |
| 88 | |
| 89 Developers | |
| 90 ========== | |
| 91 | |
| 92 This script and related tools were originally developed on the 'tools' branch of | |
| 93 the following Mercurial repository: https://bitbucket.org/peterjc/galaxy-central/ | |
| 94 | |
| 95 As of July 2013, development is continuing on a dedicated GitHub repository: | |
| 96 https://github.com/peterjc/galaxy_blast | |
| 97 | |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
98 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
99 Planemo commands (which requires you have set your Tool Shed access details in |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
100 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
101 |
|
15
60d0c6c1a71f
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 3f6b5c953d522a724bbcd403bcb86f1e2757a556-dirty
peterjc
parents:
14
diff
changeset
|
102 $ planemo shed_update -t testtoolshed --check_diff ~/repositories/galaxy_blast/tools/blastxml_to_top_descr/ |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
103 ... |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
104 |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
105 or:: |
| 11 | 106 |
|
15
60d0c6c1a71f
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit 3f6b5c953d522a724bbcd403bcb86f1e2757a556-dirty
peterjc
parents:
14
diff
changeset
|
107 $ planemo shed_update -t toolshed --check_diff ~/repositories/galaxy_blast/tools/blastxml_to_top_descr/ |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
108 ... |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
109 |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
110 To just build and check the tar ball, use:: |
| 11 | 111 |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
112 $ planemo shed_upload --tar_only ~/repositories/galaxy_blast/tools/blastxml_to_top_descr/ |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
113 ... |
|
20
c0c0a615d7cc
planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/blastxml_to_top_descr commit dc88568c900086550ce206dd83bad65e991df743-dirty
peterjc
parents:
19
diff
changeset
|
114 $ tar -tzf shed_upload.tar.gz |
|
14
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
115 test-data/blastp_four_human_vs_rhodopsin.xml |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
116 test-data/blastp_four_human_vs_rhodopsin_converted_ext.tabular |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
117 test-data/blastp_four_human_vs_rhodopsin_top3.tabular |
|
b46c041afbe4
planemo upload for repository https://github.com/peterjc/galaxy_blast/tools/blastxml_to_top_descr commit 87df4063e559fe6a4db806a52d657404c2ad766c
peterjc
parents:
13
diff
changeset
|
118 test-data/blastp_four_human_vs_rhodopsin_top3_positive.tabular |
| 11 | 119 tools/blastxml_to_top_descr/README.rst |
| 120 tools/blastxml_to_top_descr/blastxml_to_top_descr.py | |
| 121 tools/blastxml_to_top_descr/blastxml_to_top_descr.xml | |
| 122 tools/blastxml_to_top_descr/repository_dependencies.xml | |
| 123 | |
| 124 | |
| 125 Licence (MIT) | |
| 126 ============= | |
| 127 | |
| 128 Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 129 of this software and associated documentation files (the "Software"), to deal | |
| 130 in the Software without restriction, including without limitation the rights | |
| 131 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 132 copies of the Software, and to permit persons to whom the Software is | |
| 133 furnished to do so, subject to the following conditions: | |
| 134 | |
| 135 The above copyright notice and this permission notice shall be included in | |
| 136 all copies or substantial portions of the Software. | |
| 137 | |
| 138 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 139 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 140 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 141 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 142 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 143 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| 144 THE SOFTWARE. |
