annotate tools/protein_analysis/README.txt @ 21:4cee8236c77b draft

Uploaded v0.2.5 preview 5, adopt standard MIT licence.
author peterjc
date Tue, 10 Sep 2013 09:02:05 -0400
parents a538e182fab3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
1 This package contains Galaxy wrappers for a selection of standalone command
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
2 line protein analysis tools:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
3
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
4 * SignalP 3.0, THMHMM 2.0, Promoter 2.0 from the Center for Biological
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
5 Sequence Analysis at the Technical University of Denmark,
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
6 http://www.cbs.dtu.dk/cbs/
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
7
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
8 * WoLF PSORT v0.2 from http://wolfpsort.org/
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
9
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
10 * PSORTb v3 from http://www.psort.org/downloads/index.html
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
11
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
12 Also, the RXLR motif tool uses SignalP 3.0 and HMMER 2.3.2 internally.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
13
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
14 To use these Galaxy wrappers you must first install the command line tools.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
15 At the time of writing they are all free for academic use, or open source.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
16
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
17 These wrappers are copyright 2010-2013 by Peter Cock, James Hutton Institute
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
18 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
19 Contributions/revisions copyright 2011 Konrad Paszkiewicz. All rights reserved.
21
4cee8236c77b Uploaded v0.2.5 preview 5, adopt standard MIT licence.
peterjc
parents: 20
diff changeset
20 See the included LICENCE file for details (MIT open source licence).
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
21
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
22 The wrappers are available from the Galaxy Tool Shed
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
23 http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
24
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
25 Citation
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
26 ========
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
27
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
28 If you use any of these Galaxy tools in work leading to a scientific
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
29 publication, in addition to citing the invididual underlying tools, please cite:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
30
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
31 Peter Cock, Bjoern Gruening, Konrad Paszkiewicz and Leighton Pritchard (2013).
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
32 Galaxy tools and workflows for sequence analysis with applications
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
33 in molecular plant pathology. PeerJ 1:e167
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
34 http://dx.doi.org/10.7717/peerj.167
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
35
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
36 Full reference information is included in the help text for each tool.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
37
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
38
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
39 Requirements
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
40 ============
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
41
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
42 First install those command line tools you wish to use the wrappers for:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
43
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
44 1. Install the command line version of SignalP 3.0 and ensure "signalp" is
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
45 on the PATH, see: http://www.cbs.dtu.dk/services/SignalP/
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
46
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
47 2. Install the command line version of TMHMM 2.0 and ensure "tmhmm" is on
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
48 the PATH, see: http://www.cbs.dtu.dk/services/TMHMM/
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
49
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
50 3. Install the command line version of Promoter 2.0 and ensure "promoter" is
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
51 on the PATH, see: http://www.cbs.dtu.dk/services/Promoter
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
52
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
53 4. Install the WoLF PSORT v0.2 package, and ensure "runWolfPsortSummary"
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
54 is on the PATH (we use an extra wrapper script to change to the WoLF PSORT
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
55 directory, run runWolfPsortSummary, and then change back to the original
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
56 directory), see: http://wolfpsort.org/WoLFPSORT_package/version0.2/
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
57
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
58 5. Install hmmsearch from HMMER 2.3.2 (the last stable release of HMMER 2)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
59 but put it on the path under the name hmmsearch2 (allowing it to co-exist
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
60 with HMMER 3), or edit rlxr_motif.py accordingly.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
61
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
62 Verify each of the tools is installed and working from the command line
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
63 (when logged in as the Galaxy user if appropriate).
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
64
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
65
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
66 Manual Installation
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
67 ===================
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
68
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
69 1. Create a folder tools/protein_analysis under your Galaxy installation.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
70 This folder name is not critical, and can be changed if desired - you
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
71 must update the paths used in tool_conf.xml to match.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
72
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
73 2. Copy/move the following files (from this archive) there:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
74
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
75 tmhmm2.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
76 tmhmm2.py (Python wrapper script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
77
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
78 signalp3.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
79 signalp3.py (Python wrapper script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
80
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
81 promoter2.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
82 promoter2.py (Python wrapper script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
83
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
84 psortb.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
85 psortb.py (Python wrapper script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
86
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
87 wolf_psort.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
88 wolf_psort.py (Python wrapper script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
89
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
90 rxlr_motifs.xml (Galaxy tool definition)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
91 rxlr_motifs.py (Python script)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
92
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
93 seq_analysis_utils.py (shared Python code)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
94 LICENCE
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
95 README (this file)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
96
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
97 3. Edit your Galaxy conjuration file tool_conf.xml (to use the tools) AND
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
98 also tool_conf.xml.sample (to run the tests) to include the new tools
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
99 by adding:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
100
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
101 <section name="Protein sequence analysis" id="protein_analysis">
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
102 <tool file="protein_analysis/tmhmm2.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
103 <tool file="protein_analysis/signalp3.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
104 <tool file="protein_analysis/psortb.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
105 <tool file="protein_analysis/wolf_psort.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
106 <tool file="protein_analysis/rxlr_motifs.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
107 </section>
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
108 <section name="Nucleotide sequence analysis" id="nucleotide_analysis">
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
109 <tool file="protein_analysis/promoter2.xml" />
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
110 </section>
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
111
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
112 Leave out the lines for any tools you do not wish to use in Galaxy.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
113
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
114 4. Copy/move the test-data files (from this archive) to Galaxy's
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
115 subfolder test-data.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
116
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
117 5. Run the Galaxy functional tests for these new wrappers with:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
118
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
119 ./run_functional_tests.sh -id tmhmm2
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
120 ./run_functional_tests.sh -id signalp3
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
121 ./run_functional_tests.sh -id Psortb
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
122 ./run_functional_tests.sh -id rxlr_motifs
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
123
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
124 Alternatively, this should work (assuming you left the name and id as shown in
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
125 the XML file tool_conf.xml.sample):
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
126
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
127 ./run_functional_tests.sh -sid Protein_sequence_analysis-protein_analysis
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
128
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
129 To check the section ID expected, use ./run_functional_tests.sh -list
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
130
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
131 6. Restart Galaxy and check the new tools are shown and work.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
132
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
133
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
134 History
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
135 =======
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
136
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
137 v0.0.1 - Initial release
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
138 v0.0.2 - Corrected some typos in the help text
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
139 - Renamed test output file to use Galaxy convention of *.tabular
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
140 v0.0.3 - Check for tmhmm2 silent failures (no output)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
141 - Additional unit tests
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
142 v0.0.4 - Ignore comment lines in tmhmm2 output.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
143 v0.0.5 - Explicitly request tmhmm short output (may not be the default)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
144 v0.0.6 - Improvement to how sub-jobs are run (should be faster)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
145 v0.0.7 - Change SignalP default truncation from 60 to 70 to match the
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
146 SignalP webservice.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
147 v0.0.8 - Added WoLF PSORT wrapper to the suite.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
148 v0.0.9 - Added our RXLR motifs tool to the suite.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
149 v0.1.0 - Added Promoter 2.0 wrapper (similar to SignalP & TMHMM wrappers)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
150 - Support Galaxy's <parallelism> tag for SignalP, TMHMM & Promoter
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
151 v0.1.1 - Fixed an error in the header of the tabular output from Promoter
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
152 v0.1.2 - Use the new <stdio> settings in the XML wrappers to catch errors
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
153 - Use SGE style $NSLOTS for thread count (otherwise default to 4)
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
154 v0.1.3 - Added missing file whisson_et_al_rxlr_eer_cropped.hmm to Tool Shed
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
155 v0.2.0 - Added PSORTb wrapper to the suite, based on earlier work
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
156 contributed by Konrad Paszkiewicz.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
157 v0.2.1 - Use a script to create the Tool Shed tar-ball (removed some stray
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
158 files accidentally included previously via a wildcard).
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
159 v0.2.2 - Include missing test files.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
160 v0.2.3 - Added unit tests for WoLF PSORT.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
161 v0.2.4 - Added unit tests for Promoter 2
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
162 v0.2.5 - Link to Tool Shed added to help text and this documentation.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
163 - More unit tests.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
164 - Fixed bug with RXLR tool and empty FASTA files.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
165 - Fixed typo in the RXLR tool help text.
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
166 - Updated citation information (Cock et al. 2013).
21
4cee8236c77b Uploaded v0.2.5 preview 5, adopt standard MIT licence.
peterjc
parents: 20
diff changeset
167 - Adopted standard MIT licence.
20
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
168
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
169
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
170 Developers
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
171 ==========
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
172
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
173 This script and other tools are being developed on the following hg branch:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
174 http://bitbucket.org/peterjc/galaxy-central/src/tools
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
175
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
176 This incorporates the previously used hg branch:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
177 http://bitbucket.org/peterjc/galaxy-central/src/seq_analysis
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
178
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
179 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
180 the following command from the Galaxy root folder:
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
181
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
182 $ ./tools/protein_analysis/make_tmhmm_and_signalp.sh
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
183
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
184 This simplifies ensuring a consistent set of files is bundled each time,
a538e182fab3 Uploaded v0.2.5 preview 4, adding Cock et al. 2003 citation information.
peterjc
parents:
diff changeset
185 including all the relevant test files.