annotate readme.rst @ 6:e664f2137b03 default tip

Merge multiple heads.
author Dave Bouvier <dave@bx.psu.edu>
date Mon, 27 Jan 2014 14:04:46 -0500
parents a4fab0c1ae1a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
1 Galaxy wrapper for Augustus
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
2 ===========================
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
3
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
4 This wrapper is copyright 2012-2013 by Björn Grüning.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
5
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
6 This is a wrapper for the command line tool of Augustus_.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
7
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
8 .. _augustus: http://bioinf.uni-greifswald.de/augustus/
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
9
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
10 AUGUSTUS is a program that predicts genes in eukaryotic genomic sequences.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
11
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
12 Oliver Keller, Martin Kollmar, Mario Stanke, Stephan Waack (2011)
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
13 A novel hybrid gene prediction method employing protein multiple sequence alignments
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
14 Bioinformatics, doi: 10.1093/bioinformatics/btr010
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
15
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
16 Mario Stanke, Mark Diekhans, Robert Baertsch, David Haussler (2008)
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
17 Using native and syntenically mapped cDNA alignments to improve de novo gene finding
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
18 Bioinformatics, doi: 10.1093/bioinformatics/btn013
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
19
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
20 Mario Stanke and Stephan Waack (2003)
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
21 Gene Prediction with a Hidden-Markov Model and a new Intron Submodel.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
22 Bioinformatics, Vol. 19, Suppl. 2, pages ii215-ii225
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
23
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
24
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
25 Installation
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
26 ============
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
27
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
28 The recommended installation is by means of the toolshed_.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
29 If you need to install it manually here is a short introduction.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
30
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
31 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/bjoern-gruening/augustus
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
32
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
33
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
34 Install or downlaod augustus from::
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
35
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
36 http://bioinf.uni-greifswald.de/augustus/binaries/
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
37
a4fab0c1ae1a Uploaded
bjoern-gruening
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.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
39
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
40 For example::
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
41
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
42 <section name="Gene Prediction" id="gene_prediction">
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
43 <tool file="gene_prediction/tools/augustus/augustus.xml" />
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
44 </section>
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
45
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
46
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
47 Set the *AUGUSTUS_CONFIG_PATH* to /path_to_augustus/augustus/config with::
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
48
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
49 export AUGUSTUS_CONFIG_PATH=/path_to_augustus/augustus/config
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
50
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
51 or modify the wrapper and use the following additional commandline switch::
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
52
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
53 --AUGUSTUS_CONFIG_PATH=/path_to_augustus/augustus/config
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
54
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
55
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
56 History
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
57 =======
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
58
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
59 - v0.1: Initial public release
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
60 - v0.2: Added tool_dependencies.xml file and update the augustus version (thanks to James Johnson)
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
61 - v0.3: upgrade to augustus 2.7, added new organisms and new parameters, output additional sequence files
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
62
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
63 Wrapper Licence (MIT/BSD style)
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
64 ===============================
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
65
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
66 Permission to use, copy, modify, and distribute this software and its
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
67 documentation with or without modifications and for any purpose and
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
68 without fee is hereby granted, provided that any copyright notices
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
69 appear in all copies and that both those copyright notices and this
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
70 permission notice appear in supporting documentation, and that the
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
71 names of the contributors or copyright holders not be used in
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
72 advertising or publicity pertaining to distribution of the software
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
73 without specific prior permission.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
74
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
75 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
76 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
77 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
78 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
79 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
80 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
81 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
82 OR PERFORMANCE OF THIS SOFTWARE.
a4fab0c1ae1a Uploaded
bjoern-gruening
parents:
diff changeset
83