annotate README.rst @ 2:3c5f10f7dd40 draft

Updated to tool version 2.0.1 (use data table to locate freqfiles).
author pjbriggs
date Fri, 27 Nov 2015 11:06:28 -0500
parents 571cb77ab9e7
children f19e18ab01b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
1 weeder2: motif discovery in sequences from coregulated genes of a single species
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
2 ================================================================================
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
3
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
4 Galaxy tool for the Weeder2 motif discovery package:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
5
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
6 - Zambelli, F., Pesole, G. and Pavesi, G. 2014. Using Weeder, Pscan, and PscanChIP
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
7 for the Discovery of Enriched Transcription Factor Binding Site Motifs in
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
8 Nucleotide Sequences. Current Protocols in Bioinformatics. 47:2.11:2.11.1–2.11.31.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
9 http://onlinelibrary.wiley.com/doi/10.1002/0471250953.bi0211s47/full
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
10
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
11 See http://159.149.160.51/modtools/
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
12
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
13 Automated installation
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
14 ======================
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
15
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
16 Installation via the Galaxy Tool Shed will take of installing the tool wrapper and
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
17 the Weeder2 program and data, and setting the appropriate environment variables.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
18
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
19 Manual Installation
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
20 ===================
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
21
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
22 There are two files to install:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
23
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
24 - ``weeder2_wrapper.xml`` (the Galaxy tool definition)
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
25 - ``weeder2_wrapper.sh`` (the shell script wrapper)
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
26
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
27 The suggested location is in a ``tools/weeder2/`` folder. You will then
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
28 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
29 by adding the line:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
30
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
31 <tool file="weeder2/weeder2_wrapper.xml" />
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
32
2
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
33 You also need to make a copy of the ``weeder2.loc`` file (a sample version is
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
34 provided here) which lists the species for which frequency files are available.
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
35 This file should be placed in the ``tool-data`` directory of your Galaxy
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
36 installation.
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
37
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
38 Additionally you will need to install ``weeder2`` from:
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
39
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
40 - http://159.149.160.51/modtools/downloads/weeder2.html
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
41
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
42 The tool wrapper uses the following environment variables in order to find the
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
43 appropriate files:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
44
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
45 - ``WEEDER_FREQFILES_DIR`` should point to the ``FreqFiles`` directory
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
46
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
47 Also the directory holding the Weeder2 executables should be on your ``PATH``.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
48
2
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
49 Functional tests
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
50 ================
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
51
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
52 If you want to run the functional tests, copy the sample test files under
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
53 sample test files under Galaxy's ``test-data/`` directory. Then:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
54
2
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
55 ./run_tests.sh -id weeder2
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
56
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
57 You will need to have set the environment variables above.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
58
2
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
59 Reference Data
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
60 ==============
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
61
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
62 Weeder2 requires reference data in the form of frequency files for each
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
63 species of interest. A set of reference files is provided as part of the
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
64 Weeder2 installation.
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
65
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
66 Additional frequency files can be generated for novel species using the
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
67 ``w2frequency_maker`` utility available via:
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
68
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
69 - http://159.149.160.51/weederaddons/weeder2freq.html
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
70
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
71 This page also explains what input data should be used.
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
72
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
73 The location of the additional frequency files can then be specified by
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
74 adding them to the ``weeder2.loc`` file (see above).
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
75
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
76 History
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
77 =======
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
78
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
79 ========== ======================================================================
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
80 Version Changes
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
81 ---------- ----------------------------------------------------------------------
2
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
82 2.0.1 - Explicitly specify frequency files in ``weeder2.loc``.
3c5f10f7dd40 Updated to tool version 2.0.1 (use data table to locate freqfiles).
pjbriggs
parents: 1
diff changeset
83 2.0.0 - Initial version
1
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
84 ========== ======================================================================
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
85
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
86
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
87 Developers
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
88 ==========
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
89
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
90 This tool is developed on the following GitHub repository:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
91 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/weeder2
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
92
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
93 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
94 the ``package_weeder2.sh`` script.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
95
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
96
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
97 Licence (MIT)
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
98 =============
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
99
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
100 Permission is hereby granted, free of charge, to any person obtaining a copy
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
101 of this software and associated documentation files (the "Software"), to deal
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
102 in the Software without restriction, including without limitation the rights
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
103 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
104 copies of the Software, and to permit persons to whom the Software is
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
105 furnished to do so, subject to the following conditions:
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
106
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
107 The above copyright notice and this permission notice shall be included in
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
108 all copies or substantial portions of the Software.
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
109
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
110 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
111 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
112 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
113 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
114 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
115 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
571cb77ab9e7 Add citation tag and README file.
pjbriggs
parents:
diff changeset
116 THE SOFTWARE.