annotate readme.rst @ 10:0bffd4183326 draft

Uploaded
author bgruening
date Sun, 08 Sep 2013 05:08:20 -0400
parents 1aa4c036e41c
children ffa96097e5b2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
1 ================================================
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
2 Galaxy wrapper for Infernal prediction tools
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
3 ================================================
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
4
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
5 Infernal ("INFERence of RNA ALignment") is for searching DNA sequence databases
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
6 for RNA structure and sequence similarities. It is an implementation of a special
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
7 case of profile stochastic context-free grammars called covariance models (CMs).
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
8 A CM is like a sequence profile, but it scores a combination of sequence consensus
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
9 and RNA secondary structure consensus, so in many cases, it is more capable of
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
10 identifying RNA homologs that conserve their secondary structure more than their
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
11 primary sequence.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
12
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
13 This wrapper is copyright 2013 by:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
14 * Bjoern Gruening
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
15
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
16
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
17 This prepository contains wrapper for the Infernal_ command line tool.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
18
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
19 .. _Infernal: http://infernal.janelia.org/
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
20
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
21
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
22 E. P. Nawrocki, D. L. Kolbe, and S. R. Eddy, Infernal 1.0: Inference of RNA alignments , Bioinformatics 25:1335-1337 (2009), .
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
23
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
24
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
25 ============
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
26 Installation
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
27 ============
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
28
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
29 Please download install Infernal and the tool wrappers with the Galaxy Tool Shed:
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
30
9
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
31 =============
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
32 Miscellaneous
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
33 =============
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
34
10
0bffd4183326 Uploaded
bgruening
parents: 9
diff changeset
35 Included in that repository is a CM datatype for INFERNAL 1.1 and TOCKHOLM .
0bffd4183326 Uploaded
bgruening
parents: 9
diff changeset
36 If you need that datatype in an additionl package, I can source it out as separate package. Please contact me in that case.
9
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
37
1
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
38
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
39 =======
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
40 History
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
41 =======
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
42
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
43 - v1.1.0: Initial public release
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
44
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
45
9
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
46
1aa4c036e41c Uploaded
bgruening
parents: 1
diff changeset
47
1
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
48 ===============================
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
49 Wrapper Licence (MIT/BSD style)
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
50 ===============================
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
51
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
52 Permission to use, copy, modify, and distribute this software and its
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
53 documentation with or without modifications and for any purpose and
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
54 without fee is hereby granted, provided that any copyright notices
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
55 appear in all copies and that both those copyright notices and this
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
56 permission notice appear in supporting documentation, and that the
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
57 names of the contributors or copyright holders not be used in
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
58 advertising or publicity pertaining to distribution of the software
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
59 without specific prior permission.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
60
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
61 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
62 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
63 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
64 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
65 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
66 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
67 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
68 OR PERFORMANCE OF THIS SOFTWARE.
26ef7e66c39b Uploaded
bgruening
parents:
diff changeset
69