annotate README.rst @ 2:ee917702dbd8 draft

v0.0.7, support GALAXY_SLOTS etc
author peterjc
date Mon, 10 Sep 2018 09:16:13 -0400
parents 4554fcd4ef6d
children d4111d1de76f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
1 .. image:: https://travis-ci.org/abaizan/kodoja_galaxy.svg?branch=master
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
2 :alt: Linux testing with TravisCI
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
3 :target: https://travis-ci.org/abaizan/kodoja_galaxy/branches
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
4
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
5 This is a Galaxy wrapper for the tool Kodoja, which is available to install in
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
6 conda from bioconda.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
7
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
8 https://github.com/abaizan/kodoja
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
9
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
10 Galaxy wrappers for Kodoja
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
11 ==========================
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
12
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
13 These wrappers are copyright 2018 by Amanda Baizan Edge (University of
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
14 St Andrews, and The James Hutton Institute) and Peter Cock (The James
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
15 Hutton Institute). They are released under the MIT licence.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
16
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
17 These wrappers are available from the Galaxy Tool Shed at:
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
18 http://toolshed.g2.bx.psu.edu/view/abaizan/kodoja
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
19
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
20 In-development test releases are available from the Test Tool Shed at:
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
21 http://testtoolshed.g2.bx.psu.edu/view/abaizan/kodoja
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
22
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
23
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
24 Citation
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
25 ========
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
26
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
27 Please refer to the main Kodoja citation instructions.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
28
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
29
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
30 Automated Installation
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
31 ======================
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
32
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
33 Galaxy should be able to automatically install the dependencies, namely
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
34 ``kodoja`` and its dependencies like ``kraken`` and ``kaiju``, using the
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
35 conda and the bioconda recipes.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
36
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
37 See the configuration notes below.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
38
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
39
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
40 Configuration
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
41 =============
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
42
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
43 You must tell Galaxy about any Kraken and Kaiju databases using configuration
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
44 files ``kraken_databases.loc`` and ``kaiju_databases.loc`` which are located
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
45 in the ``tool-data/`` folder. Sample files are included which explain the
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
46 tab-based format to use.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
47
1
peterjc
parents: 0
diff changeset
48 For example, using https://doi.org/10.5281/zenodo.1406071 which is the
peterjc
parents: 0
diff changeset
49 database provided with Kodoja::
peterjc
parents: 0
diff changeset
50
peterjc
parents: 0
diff changeset
51 $ cd /mnt/shared/data/
peterjc
parents: 0
diff changeset
52 $ mkdir kodojaDB_v1.0
peterjc
parents: 0
diff changeset
53 $ cd kodojaDB_v1.0
peterjc
parents: 0
diff changeset
54 $ wget https://zenodo.org/record/1406071/files/kodojaDB_v1.0.tar.gz
peterjc
parents: 0
diff changeset
55 $ tar -zxvf kodojaDB_v1.0.tar.gz
peterjc
parents: 0
diff changeset
56
peterjc
parents: 0
diff changeset
57 Then update your Galaxy configuration in ``tool-data/kraken_databases.loc``
peterjc
parents: 0
diff changeset
58 to add a line like this::
peterjc
parents: 0
diff changeset
59
peterjc
parents: 0
diff changeset
60 kodojaDB_v1.0_kraken(tab)KodojaDB v1.0 (kraken), Sept 2018(tab)/mnt/shared/data/kodojaDB_v1.0/krakenDB
peterjc
parents: 0
diff changeset
61
peterjc
parents: 0
diff changeset
62 And likewise update ``tool-data/kaiju_databases.loc`` with a line like::
peterjc
parents: 0
diff changeset
63
peterjc
parents: 0
diff changeset
64 kodojaDB_v1.0_kaiju(tab)KodojaDB v1.0 (kaiju), Sept 2018(tab)/mnt/shared/data/kodojaDB_v1.0/kaijuDB
peterjc
parents: 0
diff changeset
65
peterjc
parents: 0
diff changeset
66 At the time of writing, reloading the ``*.loc`` files required restarting
peterjc
parents: 0
diff changeset
67 the Galaxy server.
peterjc
parents: 0
diff changeset
68
0
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
69
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
70 History
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
71 =======
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
72
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
73 ======= ======================================================================
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
74 Version Changes
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
75 ------- ----------------------------------------------------------------------
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
76 v0.0.0 - Initial release covering ``kodoja_search.py`` v0.0.3.
1
peterjc
parents: 0
diff changeset
77 v0.0.4 - Minor update to call ``kodoja_search.py`` v0.0.4.
peterjc
parents: 0
diff changeset
78 v0.0.6 - Minor update to call ``kodoja_search.py`` v0.0.6.
peterjc
parents: 0
diff changeset
79 - Document installing the Kodoja databases from Zenodo.
2
ee917702dbd8 v0.0.7, support GALAXY_SLOTS etc
peterjc
parents: 1
diff changeset
80 v0.0.7 - Minor update to call ``kodoja_search.py`` v0.0.6.
ee917702dbd8 v0.0.7, support GALAXY_SLOTS etc
peterjc
parents: 1
diff changeset
81 - Update help text, including zeros in columns 6 and 7.
ee917702dbd8 v0.0.7, support GALAXY_SLOTS etc
peterjc
parents: 1
diff changeset
82 - Support ``$GALAXY_SLOTS``, defaulting to using four threads.
0
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
83 ======= ======================================================================
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
84
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
85
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
86 Bug Reports
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
87 ===========
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
88
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
89 File a Galaxy wrapper issue at https://github.com/abaizan/kodoja_galaxy/issues
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
90
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
91 For issues with Kodoja itself, use https://github.com/abaizan/kodoja/issues
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
92
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
93
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
94 Developers
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
95 ==========
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
96
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
97 For pushing a release to the test or main "Galaxy Tool Shed", use the
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
98 following Planemo commands (which requires you have set your Tool Shed access
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
99 details in ``~/.planemo.yml`` and that you have access rights on the Tool
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
100 Shed)::
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
101
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
102 $ planemo shed_update -t testtoolshed --check_diff .
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
103 ...
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
104
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
105 or::
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
106
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
107 $ planemo shed_update -t toolshed --check_diff .
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
108 ...
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
109
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
110 To just build and check the tar ball, use::
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
111
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
112 $ planemo shed_upload -t testtoolshed --tar_only .
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
113 ...
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
114 $ tar -tzf shed_upload.tar.gz
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
115 LICENSE
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
116 README.rst
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
117 ...
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
118
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
119 This simplifies ensuring a consistent set of files is bundled each time,
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
120 including all the relevant test files.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
121
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
122
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
123 Licence (MIT)
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
124 =============
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
125
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
126 Permission is hereby granted, free of charge, to any person obtaining a copy
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
127 of this software and associated documentation files (the "Software"), to deal
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
128 in the Software without restriction, including without limitation the rights
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
129 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
130 copies of the Software, and to permit persons to whom the Software is
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
131 furnished to do so, subject to the following conditions:
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
132
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
133 The above copyright notice and this permission notice shall be included in
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
134 all copies or substantial portions of the Software.
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
135
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
136 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
137 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
138 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
139 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
140 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
141 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
18fe33eb7775 Uploaded kodoja_search.py v0.0.3 wrapper.
peterjc
parents:
diff changeset
142 THE SOFTWARE.