annotate README.rst @ 1:02a01ea54722 draft

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