|
0
|
1 MACS21: Model-based Analysis of ChIP-Seq (MACS 2.1.0) peak calling
|
|
|
2 ==================================================================
|
|
|
3
|
|
|
4 Galaxy tool wrapper for the peak calling function of MACS 2.1.0. MACS has been
|
|
|
5 developed by Tao Lui
|
|
|
6 https://github.com/taoliu/MACS/
|
|
|
7
|
|
|
8 The reference for MACS is:
|
|
|
9
|
|
|
10 - Zhang Y, Liu T, Meyer CA, Eeckhoute J, Johnson DS, Bernstein BE, Nusbaum C, Myers
|
|
|
11 RM, Brown M, Li W, Liu XS. Model-based analysis of ChIP-Seq (MACS). Genome Biol.
|
|
|
12 2008;9(9):R137
|
|
|
13
|
|
|
14 Automated installation
|
|
|
15 ======================
|
|
|
16
|
|
|
17 Installation via the Galaxy Tool Shed will take of installing the tool wrapper and
|
|
|
18 the MACS 2.1.0 program.
|
|
|
19
|
|
|
20 Manual Installation
|
|
|
21 ===================
|
|
|
22
|
|
|
23 There are two files to install:
|
|
|
24
|
|
|
25 - ``macs21_wrapper.xml`` (the Galaxy tool definition)
|
|
|
26 - ``macs21_wrapper.py.sh`` (the Python script wrapper)
|
|
|
27
|
|
|
28 The suggested location is in a ``tools/macs21/`` folder. You will then
|
|
|
29 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool
|
|
|
30 by adding the line:
|
|
|
31
|
|
|
32 <tool file="macs21/macs21_wrapper.xml" />
|
|
|
33
|
|
|
34 You will also need to install MACS 2.1.0 and its dependencies:
|
|
|
35
|
|
|
36 - https://pypi.python.org/pypi/MACS2
|
|
|
37
|
|
|
38 and ensure that it's on your Galaxy user's ``PATH`` when running the tool.
|
|
|
39
|
|
|
40 If you want to run the functional tests, copy the sample test files under
|
|
|
41 sample test files under Galaxy's ``test-data/`` directory. Then:
|
|
|
42
|
|
|
43 ./run_tests.sh -id macs2_wrapper
|
|
|
44
|
|
|
45
|
|
|
46 History
|
|
|
47 =======
|
|
|
48
|
|
|
49 This tool was originally based on the ``modencode-dcc`` MACS2 tool developed
|
|
|
50 by Ziru Zhou (ziruzhou@gmail.com), specifically the ``16:14f378e35191``
|
|
|
51 revision of the tool available via
|
|
|
52
|
|
|
53 - http://toolshed.g2.bx.psu.edu/view/modencode-dcc/macs2
|
|
|
54
|
|
|
55 This version has been substantially modified both to adapt it to MACS 2.1.0, and
|
|
|
56 to re-implement the internal workings of the tool to conform with current
|
|
|
57 practices in invoking commands from Galaxy, and to add new functionality.
|
|
|
58
|
|
|
59 ========== ======================================================================
|
|
|
60 Version Changes
|
|
|
61 ---------- ----------------------------------------------------------------------
|
|
1
|
62 2.1.0-5 - User must explicitly specify the format for the inputs (to allow
|
|
|
63 for paired-end data)
|
|
0
|
64 2.1.0-4 - Remove 'bdgcmp' functionality.
|
|
|
65 2.1.0-3 - Add tool tests
|
|
|
66 2.1.0-2 - Add option to create bigWig file from bedGraphs; fix bug with -B
|
|
|
67 option; make --mfold defaults consistent.
|
|
|
68 2.1.0-1 - Initial version
|
|
|
69 ========== ======================================================================
|
|
|
70
|
|
|
71
|
|
|
72 Developers
|
|
|
73 ==========
|
|
|
74
|
|
|
75 This tool is developed on the following GitHub repository:
|
|
|
76 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/macs21
|
|
|
77
|
|
|
78 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use
|
|
|
79 the ``package_macs21_wrapper.sh`` script.
|
|
|
80
|
|
|
81
|
|
|
82 Licence (MIT)
|
|
|
83 =============
|
|
|
84
|
|
|
85 Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
86 of this software and associated documentation files (the "Software"), to deal
|
|
|
87 in the Software without restriction, including without limitation the rights
|
|
|
88 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
89 copies of the Software, and to permit persons to whom the Software is
|
|
|
90 furnished to do so, subject to the following conditions:
|
|
|
91
|
|
|
92 The above copyright notice and this permission notice shall be included in
|
|
|
93 all copies or substantial portions of the Software.
|
|
|
94
|
|
|
95 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
96 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
97 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
98 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
99 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
100 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
101 THE SOFTWARE.
|
