Murasaki Project: Backup of Murasaki(No. 3)

What's Murasaki? †

Murasaki is an anchor alignment software, which is...

exteremely fast (2.5 days for whole Human x Mouse genome)
scalable (multiple sequences, up to 700+Mbp with 16GB RAM)
unlimited pattern length
repeat tolerant
intelligent noise reduction

It runs on 32/64bit Linux and other Un*x like operating systems.

↑

License †

Murasaki is distributed under the GNU General Public License.

↑

Get Murasaki! †

↑

Requirements †

Boost to build Murasaki
Perl, to run Murasaki
- Also, Term::ReadKey and Text::Wrap modules are required.

You can get both of Term::ReadKey (not included in most perl distributions) and Text::Wrap (probably included) by CPAN. As root, type: cpan Term::ReadKey Text::Wrap. Murasaki requires that these perl components work at runtime, so please don't skip this step.

↑

Optional requirements †

Murasaki interfaces with a lot of other free software to generate graphs and statistical information. To use all the features of Murasaki, you should also have:

↑

Download †

Murasaki download packages are available in Murasaki download area.
Or, keep up with the latest release using Subversion:

svn co http://murasaki.dna.bio.keio.ac.jp/svn murasaki

↑

Build instructions †

In the future, I'm planning on updating the Murasaki build process to be automated using Boost Jam, but for now it's very manual.

If your system is already set up perfectly, once you've download one of the above packages, the following should work:

cd murasaki
make
./setup.pl

You may need to tweak src/Makefile to fit your system (in particular: CXX and LIBRARIES (some distributions require that you specify boost_regex-st instead of boost_regex). If you're running bash, you can also specify CXX easily on the commandline by running "CXX=g++ make".

To set up the perl components of Murasaki, you can run ./setup.pl. This requires that you have Term::ReadKey and Text::Wrap.

↑

Getting started †

Most of the documentation for Murasaki currently exists inside the various programs. You can find out what any command does by running it with the "--help" option. For example "./murasaki --help" lists how to run Murasaki. It's long, so you might want to use "./murasaki --help | less".

An example Murasaki run might go like this:

./murasaki seq/MtC.gbk seq/Mle.gbk -p[28:36] -H2 -b24 --name myalignment	Runs the core alignment program. "seq/MtC.gbk seq/Mle.gbk" specifies the input sequences. "-p[28:36]" uses a random string consiting of 28 1's and 8 0's. -H2 specifies to include anchor component information (for calculation of tf-idf scores by filter.pl). -b24 specifies to use only 24bit hash keys (as opposed to the default 26). This is desriable (possibly necessary) for machines with limited RAM. --name obviously the output file prefix.
./simplegraph.pl output/myalignment.anchors	This generates (in this case 1) graph of the anchors produced. For multiple alignments this outputs all pairings of the component sequences.
./filter.pl --kogfile COG output/myalignment.anchors --rocr --dumpstats tfidf	--kogfile specifies where to find reference COG data for calculating sensitivity and specificity. For this case (comparing MtC and Mle) this can be downloaded from NCBI's COGs website. --rocr generates ROC plots using R and ROCR. "--dumpstats tfidf" dumps the generated tf-idf scores to a separate file which can be read by GMV.

Obviously this is just a sample run. You're strongly encouraged to read the documentation for each command. Murasaki includes a great deal of functionality without the need to write any custom scripts.