annotate README.rst @ 1:764d562755bd draft

Fix README formatting.
author pjbriggs
date Wed, 21 Mar 2018 06:45:34 -0400
parents b67ea47730d3
children 856008c4a5f3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
1 motif_tools
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
2 ===========
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
3
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
4 Galaxy tools for various motif-finding utilities developed by Ian Donaldson.
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
5
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
6 There are five tools available:
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
7
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
8 * **IUPAC scan and output each match** Returns all matches to a given IUPAC in
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
9 GFF format
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
10
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
11 * **IUPAC scan and output matches per seq** Counts the matches to a given IUPAC
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
12
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
13 * **Count unique seq in GFF** Gives the non-redundant count of sequences
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
14
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
15 * **TFBScluster two TFBS** Identifies clusters of two TFBS
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
16
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
17 * **TFBScluster three TFBS** Identifies clusters of three TFBS
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
18
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
19 Automated installation
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
20 ======================
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
21
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
22 Installation via the Galaxy Tool Shed will take of installing the tools
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
23 and the underlying dependencies.
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
24
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
25 Manual Installation
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
26 ===================
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
27
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
28 To add these to Galaxy put the following lines in tool_conf.xml for each:
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
29 tool that you want::
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
30
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
31 <tool file="motif_tools/Scan_IUPAC_output_each_match.xml" />
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
32 <tool file="motif_tools/Scan_IUPAC_output_matches_per_seq.xml" />
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
33 <tool file="motif_tools/CountUniqueIDs.xml" />
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
34 <tool file="motif_tools/TFBScluster_candidates_2TFBS.xml" />
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
35 <tool file="motif_tools/TFBScluster_candidates_3TFBS.xml" />
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
36
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
37 The tools also require Perl and ``Bioperl`` to be installed.
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
38
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
39 History
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
40 =======
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
41
1
764d562755bd Fix README formatting.
pjbriggs
parents: 0
diff changeset
42 ========== ======================================================================
0
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
43 Version Changes
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
44 ---------- ----------------------------------------------------------------------
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
45 - 1.0.1 Updates to use conda dependency resolution and tidy up XML
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
46 - 1.0.0 Initial version
1
764d562755bd Fix README formatting.
pjbriggs
parents: 0
diff changeset
47 ========== ======================================================================
0
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
48
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
49 Developers
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
50 ==========
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
51
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
52 This tool is developed on the following GitHub repository:
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
53 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/tools/macs21
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
54
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
55
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
56 Licence (MIT)
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
57 =============
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
58
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
59 Permission is hereby granted, free of charge, to any person obtaining a copy
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
60 of this software and associated documentation files (the "Software"), to deal
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
61 in the Software without restriction, including without limitation the rights
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
62 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
63 copies of the Software, and to permit persons to whom the Software is
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
64 furnished to do so, subject to the following conditions:
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
65
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
66 The above copyright notice and this permission notice shall be included in
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
67 all copies or substantial portions of the Software.
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
68
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
69 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
70 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
71 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
72 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
73 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
74 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
b67ea47730d3 Version 1.0.1.
pjbriggs
parents:
diff changeset
75 THE SOFTWARE.