annotate readme.rst @ 2:a77a4e9921e0 draft

Uploaded
author bgruening
date Wed, 06 May 2015 14:31:02 -0400
parents e2b822d7408f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
1 Galaxy wrapper for Augustus
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
2 ===========================
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
3
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
4 This wrapper is copyright 2012-2013 by Björn Grüning.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
5
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
6 This is a wrapper for the command line tool of Augustus_.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
7
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
8 .. _augustus: http://bioinf.uni-greifswald.de/augustus/
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
9
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
10 AUGUSTUS is a program that predicts genes in eukaryotic genomic sequences.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
11
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
12 Oliver Keller, Martin Kollmar, Mario Stanke, Stephan Waack (2011)
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
13 A novel hybrid gene prediction method employing protein multiple sequence alignments
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
14 Bioinformatics, doi: 10.1093/bioinformatics/btr010
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
15
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
16 Mario Stanke, Mark Diekhans, Robert Baertsch, David Haussler (2008)
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
17 Using native and syntenically mapped cDNA alignments to improve de novo gene finding
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
18 Bioinformatics, doi: 10.1093/bioinformatics/btn013
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
19
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
20 Mario Stanke and Stephan Waack (2003)
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
21 Gene Prediction with a Hidden-Markov Model and a new Intron Submodel.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
22 Bioinformatics, Vol. 19, Suppl. 2, pages ii215-ii225
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
23
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
24
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
25 Installation
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
26 ============
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
27
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
28 The recommended installation is by means of the toolshed_.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
29 If you need to install it manually here is a short introduction.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
30
1
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
31 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/bgruening/augustus
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
32
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
33
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
34 Install or downlaod augustus from::
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
35
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
36 http://bioinf.uni-greifswald.de/augustus/binaries/
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
37
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
38 and follow the installation instructions or copy the binaries into your $PATH. To install the wrapper copy the augustus folder in the galaxy tools folder and modify the tools_conf.xml file to make the tool available to Galaxy.
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
39
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
40 For example::
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
41
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
42 <section name="Gene Prediction" id="gene_prediction">
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
43 <tool file="gene_prediction/tools/augustus/augustus.xml" />
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
44 </section>
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
45
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
46
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
47 Set the *AUGUSTUS_CONFIG_PATH* to /path_to_augustus/augustus/config with::
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
48
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
49 export AUGUSTUS_CONFIG_PATH=/path_to_augustus/augustus/config
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
50
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
51 or modify the wrapper and use the following additional commandline switch::
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
52
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
53 --AUGUSTUS_CONFIG_PATH=/path_to_augustus/augustus/config
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
54
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
55
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
56 History
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
57 =======
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
58
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
59 - v0.1: Initial public release
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
60 - v0.2: Added tool_dependencies.xml file and update the augustus version (thanks to James Johnson)
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
61 - v0.3: upgrade to augustus 2.7, added new organisms and new parameters, output additional sequence files
1
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
62 - v0.3.1: added parallelism and changed the output parameters from boolean to a select box
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
63
1
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
64 Licence (MIT)
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
65 =============
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
66
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
67 Permission is hereby granted, free of charge, to any person obtaining a copy
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
68 of this software and associated documentation files (the "Software"), to deal
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
69 in the Software without restriction, including without limitation the rights
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
70 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
71 copies of the Software, and to permit persons to whom the Software is
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
72 furnished to do so, subject to the following conditions:
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
73
1
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
74 The above copyright notice and this permission notice shall be included in
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
75 all copies or substantial portions of the Software.
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
76
1
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
77 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
78 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
79 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
80 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
81 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
82 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
e2b822d7408f Uploaded
bgruening
parents: 0
diff changeset
83 THE SOFTWARE.
0
af307d3285c5 Uploaded
bgruening
parents:
diff changeset
84