|
0
|
1 BAM coverage statistics using samtools idxstats and depth
|
|
|
2 =========================================================
|
|
|
3
|
|
|
4 This tool is copyright 2014 by Peter Cock, The James Hutton Institute
|
|
|
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
|
|
|
6 See the licence text below.
|
|
|
7
|
|
|
8 Internally this tool uses the command-line samtools suite.
|
|
|
9
|
|
|
10 This tool is available from the Galaxy Tool Shed at:
|
|
|
11 http://toolshed.g2.bx.psu.edu/view/peterjc/coverage_stats
|
|
|
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
|
|
|
24 This expects samtools to be on the ``$PATH``, and was tested using v0.1.19.
|
|
|
25
|
|
|
26 To install the wrapper copy or move the following files under the Galaxy tools
|
|
|
27 folder, e.g. in a ``tools/coverage_stats`` folder:
|
|
|
28
|
|
|
29 * ``coverage_stats.xml`` (the Galaxy tool definition)
|
|
|
30 * ``coverage_stats.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="coverage_stats/coverage_stats.xml" />
|
|
|
37
|
|
|
38 If you wish to run the unit tests, also move/copy the ``test-data/`` files
|
|
|
39 under Galaxy's ``test-data/`` folder. Then::
|
|
|
40
|
|
|
41 $ ./run_tests.sh -id coverage_stats
|
|
|
42
|
|
|
43 That's it.
|
|
|
44
|
|
|
45
|
|
|
46 History
|
|
|
47 =======
|
|
|
48
|
|
|
49 ======= ======================================================================
|
|
|
50 Version Changes
|
|
|
51 ------- ----------------------------------------------------------------------
|
|
|
52 v0.0.1 - Initial public release
|
|
|
53 ======= ======================================================================
|
|
|
54
|
|
|
55
|
|
|
56 Developers
|
|
|
57 ==========
|
|
|
58
|
|
|
59 Development is on this GitHub repository:
|
|
|
60 https://github.com/peterjc/pico_galaxy/tree/master/tools/coverage_stats
|
|
|
61
|
|
|
62 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
|
|
|
63 the following command from the Galaxy root folder::
|
|
|
64
|
|
|
65 $ tar -czf coverage_stats.tar.gz tools/coverage_stats/README.rst tools/coverage_stats/coverage_stats.xml tools/coverage_stats/coverage_stats.py tools/coverage_stats/tool_dependencies.xml test-data/ex1.bam test-data/ex1.coverage_stats.tabular test-data/coverage_test.bam test-data/coverage_test.coverage_stats.tabular
|
|
|
66
|
|
|
67 Check this worked::
|
|
|
68
|
|
|
69 $ tar -tzf coverage_stats.tar.gz
|
|
|
70 tools/coverage_stats/README.rst
|
|
|
71 tools/coverage_stats/coverage_stats.xml
|
|
|
72 tools/coverage_stats/coverage_stats.py
|
|
|
73 tools/coverage_stats/tool_dependencies.xml
|
|
|
74 test-data/ex1.bam
|
|
|
75 test-data/ex1.coverage_stats.tabular
|
|
|
76 test-data/coverage_test.bam
|
|
|
77 test-data/coverage_test.coverage_stats.tabular
|
|
|
78
|
|
|
79
|
|
|
80 Licence (MIT)
|
|
|
81 =============
|
|
|
82
|
|
|
83 Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
84 of this software and associated documentation files (the "Software"), to deal
|
|
|
85 in the Software without restriction, including without limitation the rights
|
|
|
86 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
87 copies of the Software, and to permit persons to whom the Software is
|
|
|
88 furnished to do so, subject to the following conditions:
|
|
|
89
|
|
|
90 The above copyright notice and this permission notice shall be included in
|
|
|
91 all copies or substantial portions of the Software.
|
|
|
92
|
|
|
93 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
94 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
95 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
96 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
97 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
98 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
99 THE SOFTWARE.
|
|
|
100
|
|
|
101 NOTE: This is the licence for the Galaxy Wrapper only.
|
|
|
102 samtools is available and licenced separately.
|
