source: trunk/GDE/MAFFT/mafft-7.055-with-extensions/extensions/mxscarna_src/README

Last change on this file was 10371, checked in by aboeckma, 11 years ago

updated mafft version. Added extensions (no svn ignore, yet)

File size: 4.2 KB
Line 
11.Program name
2 MXSCARNA
3
42.Author
5 Yasuo Tabei
6
7 Department of Computational Biology,
8 Graduate School of Frontier Science,
9 The University of Tokyo
10 and
11 Computational Biology Research Center (CBRC),
12 National Institute of Advanced Industrial Science and Technology (AIST)
13
14 E-mail: scarna@m.aist.go.jp
15
163.What is MXSCARNA
17 MXSCARNA (Multiplex Stem Candidate Aligner for RNAs) is a tool for
18 fast structural multiple alignment of RNA sequences using progressive
19 alignment based on pairwise structural alignment algorithm of SCARNA.
20
214.License
22 While its original source code is provided as free software, MXSCARNA
23 contains the source codes of ProbCons and Rfold and the energy parameters
24 of Vienna RNA package (version 1.5).
25 The author thanks Dr. Chuong Do, Dr. Hisanori Kiryu and Dr. Ivo Hofacker,
26 the authors of ProbCons, Rfold and Vienna RNA package respectively,
27 and Institute for Theoretical Chemistry of the  University of Vienna.
28
29 The source code of Rfold is located in ./src/rfold-0.1, which includes
30 energy parameters of Vienna RNA package in ./src/rfold-0.1/src/vienna.
31 Energy parameters of Vienna RNA package are also included in the source
32 code of MXSCARNA (./src/vienna). Please follow ./src/rfold-0.1/readme.txt
33 file, which describes the license of Rfold, and
34 ./src/rfold-0.1/src/vienna/COPYING file and ./src/vienna/COPYING file,
35 which describe the copyright notice of the Vienna RNA package.
36 The source code of ProbCons is located in ./src/probconsRNA. Please follow
37 ./src/probcons/README.
38
39 The original part of MXSCARNA is provided as free software. It is
40 distributed in the hope that it will be useful but WITHOUT ANY WARRANTY;
41 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
42 PARTICULAR PURPOSE.
43
44 Permission is granted for research, educational, and commercial use
45 and modification so long as
46 1) the package and any derived works are not redistributed for any fee,
47    other than media costs,
48 2) proper credit is given to
49    the authors of MXSCARNA, ProbCons, Rfold and Vienna RNA package,
50    the Univeristy of Tokyo,
51    Computational Biology Research Center (CBRC), AIST
52    and Institute for Theoretical Chemistry of the  University of Vienna.
53
54 If you want to include this software in a commercial product, please
55 contact the author.
56
575.Citation
58 Yasuo Tabei, Hisanori Kiryu, Taishin Kin, Kiyoshi Asai:
59 "A fast structural multiple alignment method for long RNA sequences,"
60 BMC bioinformatics, to appear.
61
626.References
63
64 Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S. 2005.
65 PROBCONS: Probabilistic Consistency-based Multiple Sequence Alignment.
66 Genome Research 15: 330-340.
67
68 Hisanori Kiryu, Taishin Kin, and Kiyoshi Asai
69 Rfold: An exact algorithm for computing local base pairing probabilities
70 Bioinformatics, Advance Access published on December 4, 2007;
71 doi:10.1093/bioinformatics/btm591
72
73 Ivo L. Hofacker
74 Vienna RNA secondary structure server
75 Nucleic Acids Res., Jul 2003; 31: 3429 - 3431.
76
77 Yasuo Tabei, Koji Tsuda, Taishin Kin, and Kiyoshi Asai
78 SCARNA: fast and accurate structural alignment of RNA sequences by matching fixed-length stem fragments
79 Bioinformatics 2006 22(14):1723-1729.
80
817.Install
82 The program was tested using gcc 3.3.3 on linux machines and gcc 3.4 on
83 cygwin Some gcc specific features are currently used.
84
85 The command to compile this software is as follows:
86
87 make
88 cd program
89
908.Usage
91
92 ./mxscarna [options] seqfile
93
94 seqfile:
95   sequence file is multi fasta format.
96
97 options:
98   -clustalw
99      use CLUSTALW output format instead of MFA
100
101   -stockholm
102      use STOCKHOLM output format instead of MFA
103
104   -mxscarna
105      use original output format instead of MFA
106
107   -l <SCSLENGTH>
108      the length of stem candidates (default:2)
109
110   -b <BASEPROBTHRESHOLD>
111      the threshold of base-pairing probability (default:0.01)
112
113   -g <BASEPAIRSCORECONT>
114      the control parameter of the prediction of base-pairs, (default:6)
115
116   -rfold
117      use Rfold instead of global McCaskill algorithm to calcurate base
118      paring probality matrices, (default: off)
119
120   -w <BANDWIDTH>
121      the control parameter of the distance of stem candidates, (default:500)
122
1239.Example
124   ./mxscarna -mxscarna ../sample/trna.mfa
125
12610.Version History
1271. 1/16/2008 (Yasuo Tabei)
128-- MXSCARNA ver 2.0 release
129  - Rfold was included.
Note: See TracBrowser for help on using the repository browser.