Mercurial > repos > kuyt002 > mummer_toolsuite

annotate MUMmer/README_mummer @ 0:61f30d177448 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial commit on Mummer toolsuite on toolshed
author eric
date Tue, 31 Mar 2015 14:19:49 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
1 # Created/shared May 2011
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
2 #
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
3 # Alex Bossers
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
4 # Central Veterinary Institute
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
5 # Wageningen University and Research centre
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
6 # Lelystad, The Netherlands
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
7 #
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
8 # Comments/improvements/bugs: Alex (dot) Bossers (at) wur (dot) nl
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
9
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
10
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
11 # WHAT IT DOES
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
12 The MUMmer suite is a set of very basic wrappers for the MUMmer genome comparison tools. Most common operations should be possible
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
13 by using these wrappers. MUMmer works fast on smaller (bacterial) genomes but can also cope with eukaryotic genomes.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
14
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
15 In addition to the original MUMmer tools it also contains an additional conversion script to convert MUMmer comparison files,
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
16 the so-called coords files into a readible format for Artemis Comparison Tool (ACT; Sanger UK).
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
17
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
18
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
19 # REQUIREMENTS
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
20 - Perl
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
21 - Galaxy :)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
22 - MUMmer newer than version 3.20;
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
23 even though older versions might work as well.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
24 Get your MUMmer here: http://mummer.sourceforge.net/
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
25 Make sure MUMmer is in your PATH and/or update the tool xml configs and wrappers for the full MUMmer path
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
26 if it is different from /opt/MUMmer/MUMmer.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
27 - ACT can be run locally or via Webstart if you want to visualise genome comparisons in detail: http://www.sanger.ac.uk/resources/software/act
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
28 - GNUplot is a requirement for the MUMmerplot part (see MUMmer installation documentation)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
29
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
30
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
31 # SETUP
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
32 Just unpack the tool xml and perl script somewhere appropriate and adapt the MUMmer installation part if different from above. Plug the tool in the tool_config.xml
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
33 of your galaxy instance and refresh the tools or restart the galaxy server.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
34
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
35
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
36 # TESTING
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
37 You can test the code by running Nucmer on the test data and visualise the results in MUMmerplot.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
38 It should return a MUMmerplot identical to the image provided. For reference I also included the corresponding log file.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
39
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
40
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
41 # LICENSE
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
42 Copyright (c) 2011 Central Veterinary Institute of Wageningen UR, Lelystad, The Netherlands.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
43 MUMmer is copyright by its respective owner. See their licensing details.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
44
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
45 Our wrappers/programs are free software; you can redistribute it and/or modify
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
46 it under the terms of the GNU General Public License as published by
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
47 the Free Software Foundation; either version 3 of the License, or
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
48 (at your option) any later version.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
49
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
50 When distributing the tools please include this original reference.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
51
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
52 Use this tool at your own risk. Even though we tried to build tools and wrappers that free of errors,
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
53 check your output since it might be erroneous. We will not be relyable to any failure this may have caused.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
54
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
55 If you like these scripts, please acknowledge our work.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
56