annotate readme.rst @ 2:b1ad88bbc5fa draft default tip

Uploaded
author bgruening
date Mon, 12 Aug 2013 11:55:07 -0400
parents 841357e0acbf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
841357e0acbf Uploaded
bgruening
parents:
diff changeset
1 =======================================
841357e0acbf Uploaded
bgruening
parents:
diff changeset
2 Galaxy wrapper for Glimmer gene calling
841357e0acbf Uploaded
bgruening
parents:
diff changeset
3 =======================================
841357e0acbf Uploaded
bgruening
parents:
diff changeset
4
841357e0acbf Uploaded
bgruening
parents:
diff changeset
5 This wrapper is copyright 2012-2013 by Björn Grüning.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
6
841357e0acbf Uploaded
bgruening
parents:
diff changeset
7 This is a wrapper for the command line tool of Glimmer3_.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
8
2
b1ad88bbc5fa Uploaded
bgruening
parents: 0
diff changeset
9 .. _Glimmer3: http://www.cbcb.umd.edu/software/glimmer/
0
841357e0acbf Uploaded
bgruening
parents:
diff changeset
10
841357e0acbf Uploaded
bgruening
parents:
diff changeset
11 Glimmer is a system for finding genes in microbial DNA,
841357e0acbf Uploaded
bgruening
parents:
diff changeset
12 especially the genomes of bacteria, archaea, and viruses.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
13 Glimmer (Gene Locator and Interpolated Markov ModelER) uses interpolated
841357e0acbf Uploaded
bgruening
parents:
diff changeset
14 Markov models (IMMs) to identify the coding regions and distinguish them from noncoding DNA.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
15
2
b1ad88bbc5fa Uploaded
bgruening
parents: 0
diff changeset
16 | S. Salzberg, A. Delcher, S. Kasif, and O. White. Microbial gene identification using interpolated Markov models, Nucleic Acids Research 26:2 (1998), 544-548.
0
841357e0acbf Uploaded
bgruening
parents:
diff changeset
17
2
b1ad88bbc5fa Uploaded
bgruening
parents: 0
diff changeset
18 | A.L. Delcher, D. Harmon, S. Kasif, O. White, and S.L. Salzberg. Improved microbial gene identification with GLIMMER, Nucleic Acids Research 27:23 (1999), 4636-4641.
0
841357e0acbf Uploaded
bgruening
parents:
diff changeset
19
2
b1ad88bbc5fa Uploaded
bgruening
parents: 0
diff changeset
20 | A.L. Delcher, K.A. Bratke, E.C. Powers, and S.L. Salzberg. Identifying bacterial genes and endosymbiont DNA with Glimmer. Bioinformatics (Advance online version) (2007).
0
841357e0acbf Uploaded
bgruening
parents:
diff changeset
21
841357e0acbf Uploaded
bgruening
parents:
diff changeset
22
841357e0acbf Uploaded
bgruening
parents:
diff changeset
23 ============
841357e0acbf Uploaded
bgruening
parents:
diff changeset
24 Installation
841357e0acbf Uploaded
bgruening
parents:
diff changeset
25 ============
841357e0acbf Uploaded
bgruening
parents:
diff changeset
26
841357e0acbf Uploaded
bgruening
parents:
diff changeset
27 Since version 0.2 the recommended installation procedure is via the `Galaxy Tool Shed`.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
28
841357e0acbf Uploaded
bgruening
parents:
diff changeset
29 .. _`Galaxy Tool Shed`: http://toolshed.g2.bx.psu.edu/view/bjoern-gruening/glimmer3
841357e0acbf Uploaded
bgruening
parents:
diff changeset
30
841357e0acbf Uploaded
bgruening
parents:
diff changeset
31 To install Glimmer3 manually, please download Glimmer3 from::
841357e0acbf Uploaded
bgruening
parents:
diff changeset
32
841357e0acbf Uploaded
bgruening
parents:
diff changeset
33 http://www.cbcb.umd.edu/software/glimmer/glimmer302.tar.gz
841357e0acbf Uploaded
bgruening
parents:
diff changeset
34
841357e0acbf Uploaded
bgruening
parents:
diff changeset
35 and follow the installation instructions. You can also use packages from your distribution like http://packages.debian.org/stable/science/tigr-glimmer
841357e0acbf Uploaded
bgruening
parents:
diff changeset
36
841357e0acbf Uploaded
bgruening
parents:
diff changeset
37 To install the wrapper copy the glimmer3 folder in the galaxy tools
841357e0acbf Uploaded
bgruening
parents:
diff changeset
38 folder and modify the tools_conf.xml file to make the tool available to Galaxy.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
39 For example::
841357e0acbf Uploaded
bgruening
parents:
diff changeset
40
841357e0acbf Uploaded
bgruening
parents:
diff changeset
41 <tool file="gene_prediction/tools/glimmer3/glimmer_w_icm.xml" />
841357e0acbf Uploaded
bgruening
parents:
diff changeset
42 <tool file="gene_prediction/tools/glimmer3/glimmer_wo_icm.xml" />
841357e0acbf Uploaded
bgruening
parents:
diff changeset
43 <tool file="gene_prediction/tools/glimmer3/glimmer_build-icm.xml" />
841357e0acbf Uploaded
bgruening
parents:
diff changeset
44
841357e0acbf Uploaded
bgruening
parents:
diff changeset
45 =======
841357e0acbf Uploaded
bgruening
parents:
diff changeset
46 History
841357e0acbf Uploaded
bgruening
parents:
diff changeset
47 =======
841357e0acbf Uploaded
bgruening
parents:
diff changeset
48
841357e0acbf Uploaded
bgruening
parents:
diff changeset
49 - v0.1: Initial public release
841357e0acbf Uploaded
bgruening
parents:
diff changeset
50 - v0.2: Add tool shed integration
841357e0acbf Uploaded
bgruening
parents:
diff changeset
51
841357e0acbf Uploaded
bgruening
parents:
diff changeset
52 ===============================
841357e0acbf Uploaded
bgruening
parents:
diff changeset
53 Wrapper Licence (MIT/BSD style)
841357e0acbf Uploaded
bgruening
parents:
diff changeset
54 ===============================
841357e0acbf Uploaded
bgruening
parents:
diff changeset
55
841357e0acbf Uploaded
bgruening
parents:
diff changeset
56 Permission to use, copy, modify, and distribute this software and its
841357e0acbf Uploaded
bgruening
parents:
diff changeset
57 documentation with or without modifications and for any purpose and
841357e0acbf Uploaded
bgruening
parents:
diff changeset
58 without fee is hereby granted, provided that any copyright notices
841357e0acbf Uploaded
bgruening
parents:
diff changeset
59 appear in all copies and that both those copyright notices and this
841357e0acbf Uploaded
bgruening
parents:
diff changeset
60 permission notice appear in supporting documentation, and that the
841357e0acbf Uploaded
bgruening
parents:
diff changeset
61 names of the contributors or copyright holders not be used in
841357e0acbf Uploaded
bgruening
parents:
diff changeset
62 advertising or publicity pertaining to distribution of the software
841357e0acbf Uploaded
bgruening
parents:
diff changeset
63 without specific prior permission.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
64
841357e0acbf Uploaded
bgruening
parents:
diff changeset
65 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
841357e0acbf Uploaded
bgruening
parents:
diff changeset
66 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
841357e0acbf Uploaded
bgruening
parents:
diff changeset
67 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
841357e0acbf Uploaded
bgruening
parents:
diff changeset
68 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
841357e0acbf Uploaded
bgruening
parents:
diff changeset
69 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
841357e0acbf Uploaded
bgruening
parents:
diff changeset
70 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
841357e0acbf Uploaded
bgruening
parents:
diff changeset
71 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
841357e0acbf Uploaded
bgruening
parents:
diff changeset
72 OR PERFORMANCE OF THIS SOFTWARE.
841357e0acbf Uploaded
bgruening
parents:
diff changeset
73