Mercurial > repos > peterjc > samtools_depad
annotate tools/samtools_depad/README.rst @ 1:01f8967ce1e0 draft
v0.0.3; internal changes to help packaging with planemo
author | peterjc |
---|---|
date | Wed, 13 May 2015 10:15:02 -0400 |
parents | 2d303f2e09e0 |
children | 02572789ef6c |
rev | line source |
---|---|
0 | 1 Galaxy wrapper for samtools depad |
2 ================================= | |
3 | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
4 This wrapper is copyright 2014-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 is a wrapper for part of the command line samtools suite, v0.1.19 | |
9 | |
10 This wrapper is available from the Galaxy Tool Shed at: | |
11 http://toolshed.g2.bx.psu.edu/view/peterjc/samtools_idxstats | |
12 | |
13 | |
14 Automated Installation | |
15 ====================== | |
16 | |
17 This should be straightforward, Galaxy should automatically download and install | |
18 samtools 0.1.19 if required. | |
19 | |
20 | |
21 Manual Installation | |
22 =================== | |
23 | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
24 This expects samtools to be on the ``$PATH``, and was tested using v0.1.19. |
0 | 25 |
26 To install the wrapper copy or move the following files under the Galaxy tools | |
27 folder, e.g. in a ``tools/samtools_depad`` folder: | |
28 | |
29 * ``samtools_depad.xml`` (the Galaxy tool definition) | |
30 * ``samtools_depad.py`` (the Python wrapper script) | |
31 * ``README.rst`` (this file) | |
32 | |
33 You will also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer | |
34 the tool. Just add the line, perhaps under the NGS tools section:: | |
35 | |
36 <tool file="samtools_depad/samtools_depad.xml" /> | |
37 | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
38 If you wish to run the unit tests, also move/copy the ``test-data/`` files |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
39 under Galaxy's ``test-data/`` folder. Then:: |
0 | 40 |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
41 $ ./run_tests.sh -id samtools_depad |
0 | 42 |
43 That's it. | |
44 | |
45 | |
46 History | |
47 ======= | |
48 | |
49 ======= ====================================================================== | |
50 Version Changes | |
51 ------- ---------------------------------------------------------------------- | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
52 v0.0.1 - Initial public release. |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
53 v0.0.2 - Embed samtools citation in the tool XML. |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
54 - Removed unused imports from Python wrapper script. |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
55 v0.0.3 - Reorder XML elements (internal change only). |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
56 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). |
0 | 57 ======= ====================================================================== |
58 | |
59 | |
60 Developers | |
61 ========== | |
62 | |
63 Development is on this GitHub repository: | |
64 https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_depad | |
65 | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
66 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
67 Planemo commands (which requires you have set your Tool Shed access details in |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
68 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: |
0 | 69 |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
70 $ planemo shed_upload --shed_target testtoolshed --check_diff ~/repositories/pico_galaxy/tools/samtools_depad/ |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
71 ... |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
72 |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
73 or:: |
0 | 74 |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
75 $ planemo shed_upload --shed_target toolshed --check_diff ~/repositories/pico_galaxy/tools/samtools_depad/ |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
76 ... |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
77 |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
78 To just build and check the tar ball, use:: |
0 | 79 |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
80 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/samtools_depad/ |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
81 ... |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
82 $ tar -tzf shed_upload.tar.gz |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
83 test-data/sam_spec_padded.bam |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
84 test-data/sam_spec_padded.depad.bam |
0 | 85 test-data/sam_spec_padded.fasta |
86 test-data/sam_spec_padded.sam | |
1
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
87 tools/samtools_depad/README.rst |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
88 tools/samtools_depad/samtools_depad.py |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
89 tools/samtools_depad/samtools_depad.xml |
01f8967ce1e0
v0.0.3; internal changes to help packaging with planemo
peterjc
parents:
0
diff
changeset
|
90 tools/samtools_depad/tool_dependencies.xml |
0 | 91 |
92 | |
93 Licence (MIT) | |
94 ============= | |
95 | |
96 Permission is hereby granted, free of charge, to any person obtaining a copy | |
97 of this software and associated documentation files (the "Software"), to deal | |
98 in the Software without restriction, including without limitation the rights | |
99 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
100 copies of the Software, and to permit persons to whom the Software is | |
101 furnished to do so, subject to the following conditions: | |
102 | |
103 The above copyright notice and this permission notice shall be included in | |
104 all copies or substantial portions of the Software. | |
105 | |
106 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
107 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
108 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
109 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
110 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
111 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
112 THE SOFTWARE. | |
113 | |
114 NOTE: This is the licence for the Galaxy Wrapper only. | |
115 samtools is available and licenced separately. |