annotate readme.txt @ 2:0fef99b5f63f draft default tip

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