annotate readme.rst @ 0:d34f31cbc9dd draft

Uploaded
author bgruening
date Sat, 06 Jul 2013 10:37:13 -0400
parents
children 358f58401cd6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
1 Galaxy wrapper for t-RNA prediction tools
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
2 =========================================
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
3
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
4 This wrapper is copyright 2012-2013 by Björn Grüning.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
5
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
6 This prepository contains wrapper for the command line tools of tRNAscan-SE_ and Arogorn_.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
7
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
8 .. _tRNAscan-SE: http://lowelab.ucsc.edu/tRNAscan-SE/
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
9 .. _Arogorn: http://mbio-serv2.mbioekol.lu.se/ARAGORN/
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
10
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
11 Dean Laslett and Bjorn Canback
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
12 ARAGORN, a program to detect tRNA genes and tmRNA genes in nucleotide sequences Nucl. Acids Res. (2004) 32(1): 11-16
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
13 doi:10.1093/nar/gkh152
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
14
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
15 Todd M. Lowe and Sean R. Eddy
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
16 tRNAscan-SE: A Program for Improved Detection of Transfer RNA Genes in Genomic Sequence Nucl. Acids Res. (1997) 25(5): 0955-964
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
17 doi:10.1093/nar/25.5.0955
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
18
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
19
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
20 ============
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
21 Installation
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
22 ============
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
23
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
24 The t-RNA prediction wrappers are available through the toolshed_ and can be automatically installed.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
25
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
26 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/bjoern-gruening/trna_prediction
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
27
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
28 For manuel installation, please download tRNAscan-SE from the following URL and follow the install instructions::
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
29
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
30 http://lowelab.ucsc.edu/software/tRNAscan-SE.tar.gz
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
31
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
32 Arogorn can be download from::
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
33
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
34 http://mbio-serv2.mbioekol.lu.se/ARAGORN/aragorn1.2.33.c
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
35
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
36 With a recent GNU-Compiler (gcc) you can compile it with the following command::
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
37
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
38 gcc -O3 -ffast-math -finline-functions -o aragorn aragorn1.2.33.c
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
39
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
40 Please include aragorn and tRNAscan-SE into your PATH::
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
41
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
42 export PATH=$PATH:/home/user/bin/aragorn/bin/
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
43
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
44
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
45 To install the wrappers copy the files aragorn.xml and tRNAscan.xml in the galaxy tools
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
46 folder and modify the tools_conf.xml file to make the tool available to Galaxy.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
47 For example add the following lines::
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
48
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
49 <tool file="trna_prediction/aragorn.xml" />
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
50 <tool file="trna_prediction/tRNAscan.xml" />
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
51
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
52
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
53 =======
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
54 History
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
55 =======
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
56
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
57 tRNAscan:
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
58
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
59 - v0.1: Initial public release
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
60 - v0.2: add fasta output
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
61 - v0.2.1: added tool-dependency
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
62 - v0.2.2: patch from Nicola Soranzo added
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
63 - v0.3: add unit tests, documentation improvements, bug fixes
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
64
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
65 aragorn:
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
66
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
67 - v0.1: Initial public release
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
68 - v0.2: added options, upgrade to 1.2.36, tool-dependency
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
69 - v0.3: add unit tests, documentation improvements
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
70
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
71
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
72
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
73 Wrapper Licence (MIT/BSD style)
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
74 ===============================
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
75
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
76 Permission to use, copy, modify, and distribute this software and its
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
77 documentation with or without modifications and for any purpose and
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
78 without fee is hereby granted, provided that any copyright notices
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
79 appear in all copies and that both those copyright notices and this
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
80 permission notice appear in supporting documentation, and that the
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
81 names of the contributors or copyright holders not be used in
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
82 advertising or publicity pertaining to distribution of the software
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
83 without specific prior permission.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
84
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
85 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
86 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
87 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
88 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
89 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
90 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
91 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
92 OR PERFORMANCE OF THIS SOFTWARE.
d34f31cbc9dd Uploaded
bgruening
parents:
diff changeset
93