Mercurial > repos > pjbriggs > macs21
annotate README.rst @ 2:00d73c812399 draft
Version 2.1.0-6: add sorting step in bigWig generation, and explicitly terminate tool on error from MACS2.
| author | pjbriggs |
|---|---|
| date | Wed, 22 Mar 2017 11:36:07 -0400 |
| parents | 02a01ea54722 |
| children | 4124781932db |
| rev | line source |
|---|---|
| 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 ---------- ---------------------------------------------------------------------- | |
|
2
00d73c812399
Version 2.1.0-6: add sorting step in bigWig generation, and explicitly terminate tool on error from MACS2.
pjbriggs
parents:
1
diff
changeset
|
62 2.1.0-6 - Add bedSort step into bigWig file generation; terminate with error |
|
00d73c812399
Version 2.1.0-6: add sorting step in bigWig generation, and explicitly terminate tool on error from MACS2.
pjbriggs
parents:
1
diff
changeset
|
63 when MACS finishes with non-zero exit code. |
| 1 | 64 2.1.0-5 - User must explicitly specify the format for the inputs (to allow |
| 65 for paired-end data) | |
| 0 | 66 2.1.0-4 - Remove 'bdgcmp' functionality. |
| 67 2.1.0-3 - Add tool tests | |
| 68 2.1.0-2 - Add option to create bigWig file from bedGraphs; fix bug with -B | |
| 69 option; make --mfold defaults consistent. | |
| 70 2.1.0-1 - Initial version | |
| 71 ========== ====================================================================== | |
| 72 | |
| 73 | |
| 74 Developers | |
| 75 ========== | |
| 76 | |
| 77 This tool is developed on the following GitHub repository: | |
| 78 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/macs21 | |
| 79 | |
| 80 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use | |
| 81 the ``package_macs21_wrapper.sh`` script. | |
| 82 | |
| 83 | |
| 84 Licence (MIT) | |
| 85 ============= | |
| 86 | |
| 87 Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 88 of this software and associated documentation files (the "Software"), to deal | |
| 89 in the Software without restriction, including without limitation the rights | |
| 90 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 91 copies of the Software, and to permit persons to whom the Software is | |
| 92 furnished to do so, subject to the following conditions: | |
| 93 | |
| 94 The above copyright notice and this permission notice shall be included in | |
| 95 all copies or substantial portions of the Software. | |
| 96 | |
| 97 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 98 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 99 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 100 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 101 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 102 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| 103 THE SOFTWARE. |