Mercurial > repos > peterjc > effectivet3

annotate tools/effectiveT3/README.rst @ 12:914f7ae776fc draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.12a, MIT licence, RST README, citation information
author peterjc
date Wed, 11 Sep 2013 06:11:20 -0400
parents
children 1e681e19e35c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
1 Galaxy wrapper for EffectiveT3 v1.0.1
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
2 =====================================
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
3
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
4 This wrapper is copyright 2011-2013 by Peter Cock, The James Hutton Institute
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
6 See the licence text below.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
7
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
8 This is a wrapper for the command line Java tool EffectiveT3, v1.0.1,
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
9
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
10 Jehl, Arnold and Rattei.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
11 Effective - a database of predicted secreted bacterial proteins
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
12 Nucleic Acids Research, 39(Database issue), D591-5, 2011.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
13 http://dx.doi.org/10.1093/nar/gkq1154
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
14
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
15 Arnold, Brandmaier, Kleine, Tischler, Heinz, Behrens, Niinikoski, Mewes, Horn and Rattei.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
16 Sequence-based prediction of type III secreted proteins.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
17 PLoS Pathog. 5(4):e1000376, 2009.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
18 http://dx.doi.org/10.1371/journal.ppat.1000376
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
19
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
20 http://effectors.org/
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
21
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
22 This wrapper is available from the Galaxy Tool Shed at:
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
23 http://toolshed.g2.bx.psu.edu/view/peterjc/effectivet3
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
24
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
25
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
26 Automated Installation
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
27 ======================
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
28
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
29 This should be straightforward, Galaxy should automatically download and install
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
30 the Jar files for effectiveT3 v1.0.1 and the three models (animal, plant and std).
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
31
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
32
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
33 Manual Installation
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
34 ===================
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
35
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
36 You can change the path by setting the environment variable EFFECTIVET3 to the
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
37 relevant folder, but by default it expects the following files to be installed
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
38 at these locations::
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
39
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
40 /opt/EffectiveT3/TTSS_GUI-1.0.1.jar
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
41 /opt/EffectiveT3/module/TTSS_ANIMAL-1.0.1.jar
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
42 /opt/EffectiveT3/module/TTSS_PLANT-1.0.1.jar
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
43 /opt/EffectiveT3/module/TTSS_STD-1.0.1.jar
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
44
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
45 To install the wrapper copy or move the following files under the Galaxy tools
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
46 folder, e.g. in a tools/effectiveT3 folder:
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
47
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
48 * effectiveT3.xml (the Galaxy tool definition)
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
49 * effectiveT3.py (the Python wrapper script)
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
50 * README.rst (this file)
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
51
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
52 Also copy effectiveT3.loc.sample to effectiveT3.loc in the tool-data folder
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
53 (and edit if appropriate, e.g. to add or remove a model).
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
54
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
55 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
56 tool. If you are using other protein analysis tools like TMHMM or SignalP, put
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
57 it next to them. Just add the line::
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
58
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
59 <tool file="effectiveT3/effectiveT3.xml" />
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
60
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
61 If you wish to run the unit tests, also add this to tools_conf.xml.sample
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
62 and move/copy the test-data files under Galaxy's test-data folder. Then::
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
63
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
64 $ ./run_functional_tests.sh -id effectiveT3
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
65
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
66 That's it.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
67
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
68
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
69 History
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
70 =======
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
71
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
72 ======= ======================================================================
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
73 Version Changes
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
74 ------- ----------------------------------------------------------------------
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
75 v0.0.7 - Initial public release
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
76 v0.0.8 - Include effectiveT3.loc.sample in Tool Shed
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
77 v0.0.9 - Check the return code for errors in the XML
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
78 v0.0.10 - Added unit test
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
79 v0.0.11 - Automated installation
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
80 - Record version of Python script when called from Galaxy
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
81 - Link to Tool Shed added to help text and this documentation.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
82 v0.0.12 - More explicit naming of the output dataset.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
83 - Adopt standard MIT licence.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
84 - Use reStructuredText for this README file.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
85 - Updated citation information (Cock et al. 2013).
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
86 ======= ======================================================================
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
87
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
88
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
89 Developers
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
90 ==========
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
91
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
92 This script and related tools are being developed on the following hg branch:
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
93 http://bitbucket.org/peterjc/galaxy-central/src/tools
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
94
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
95 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
96 the following command from the Galaxy root folder::
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
97
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
98 $ tar -czf effectiveT3.tar.gz tools/effectiveT3/README.rst tools/effectiveT3/effectiveT3.xml tools/effectiveT3/effectiveT3.py tools/effectiveT3/tool_dependencies.xml tool-data/effectiveT3.loc.sample test-data/four_human_proteins.fasta test-data/four_human_proteins.effectiveT3.tabular test-data/empty.fasta test-data/empty_effectiveT3.tabular
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
99
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
100
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
101 Check this worked::
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
102
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
103 $ tar -tzf effectiveT3.tar.gz
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
104 tools/effectiveT3/README.rst
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
105 tools/effectiveT3/effectiveT3.xml
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
106 tools/effectiveT3/effectiveT3.py
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
107 tools/effectiveT3/tool_dependencies.xml
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
108 tool-data/effectiveT3.loc.sample
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
109 test-data/four_human_proteins.fasta
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
110 test-data/four_human_proteins.effectiveT3.tabular
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
111 test-data/empty.fasta
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
112 test-data/empty_effectiveT3.tabular
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
113
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
114
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
115 Licence (MIT)
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
116 =============
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
117
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
118 Permission is hereby granted, free of charge, to any person obtaining a copy
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
119 of this software and associated documentation files (the "Software"), to deal
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
120 in the Software without restriction, including without limitation the rights
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
121 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
122 copies of the Software, and to permit persons to whom the Software is
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
123 furnished to do so, subject to the following conditions:
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
124
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
125 The above copyright notice and this permission notice shall be included in
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
126 all copies or substantial portions of the Software.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
127
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
128 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
129 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
130 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
131 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
132 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
133 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
134 THE SOFTWARE.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
135
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
136 NOTE: This is the licence for the Galaxy Wrapper only.
914f7ae776fc Uploaded v0.0.12a, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
137 EffectiveT3 is available and licenced separately.