Mercurial > repos > peterjc > mira_assembler

annotate tools/mira_3_4/mira.txt @ 4:03743667463c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.7, take 2, included the tool_dependencies.xml file
author peterjc
date Wed, 24 Apr 2013 12:47:08 -0400
parents c1c7d6f726b0
children e810e45bdad7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
1 Galaxy tool to wrap the MIRA sequence assembly program (v3.4)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
2 =============================================================
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
3
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
4 This tool is copyright 2011-2013 by Peter Cock, The James Hutton Institute
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
6 See the licence text below.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
7
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
8 This tool is a short Python script (to collect the MIRA output and move it
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
9 to where Galaxy expects the files, and convert MIRA's TCS file into a tab
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
10 separated file for use in Galaxy).
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
11
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
12
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
13 Automated Installation
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
14 ======================
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
15
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
16 This should be straightforward, Galaxy should automatically download and
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
17 install the precompiled binary for MIRA v3.4.0 for the Galaxy wrapper,
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
18 and run any tests.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
19
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
20
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
21 Manual Installation
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
22 ===================
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
23
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
24 There are just two Galaxy files to install:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
25
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
26 * mira.py (the Python script)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
27 * mira.xml (the Galaxy tool definition)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
28
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
29 The suggested location is a new tools/mira_3_4 folder. You will also need to
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
30 modify the tools_conf.xml file to tell Galaxy to offer the tool, and also do
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
31 this to tools_conf.xml.sample in order to run any tests:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
32
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
33 <tool file="mira_3_4/mira.xml" />
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
34
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
35 You will also need to install MIRA, we used version 3.4.1.1. See:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
36
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
37 http://chevreux.org/projects_mira.html
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
38 http://sourceforge.net/projects/mira-assembler/
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
39
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
40 WARNING: This tool was developed to construct viral genome assembly and
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
41 mapping pipelines, for which the run time and memory requirements are
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
42 negligible. For larger tasks, be aware that MIRA can require vast amounts
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
43 of RAM and run-times of over a week are possible. This tool wrapper makes
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
44 no attempt to spot and reject such large jobs.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
45
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
46
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
47 History
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
48 =======
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
49
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
50 v0.0.1 - Initial version (working prototype, using MIRA 3.2.1)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
51 v0.0.2 - Improve capture of stdout/stderr (should see it as it runs)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
52 v0.0.3 - Support Ion Torrent reads, now requires MIRA 3.4.0 or later
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
53 (some other switches changed, e.g. -OUT rrol to rrot, which
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
54 means the wrapper no longer works with MIRA 3.2.x)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
55 - The contig summary file (TCS file) was removed in MIRA 3.4
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
56 - Report all missing output files (not just first missing one)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
57 v0.0.4 - Fix problem with backbone arguments inroduced in v0.0.3
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
58 v0.0.5 - Implement the <version_command> tag to record the wrapper
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
59 version and the MIRA version being used.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
60 - Check using MIRA 3.4 (later versions have a different API)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
61 v0.0.6 - Tell MIRA to use /tmp for temporary files
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
62 - Tell MIRA to ignore long read names (otherwise it aborts)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
63 v0.0.7 - Automated installation of the 64 bit Linux MIRA binary.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
64
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
65
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
66 Developers
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
67 ==========
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
68
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
69 This script and related tools are being developed on the following hg branch:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
70 http://bitbucket.org/peterjc/galaxy-central/src/tools
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
71
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
72 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
73 the following command from the Galaxy root folder:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
74
4
03743667463c Uploaded v0.0.7, take 2, included the tool_dependencies.xml file
peterjc
parents: 3
diff changeset
75 $ tar -czf mira_wrapper.tar.gz tools/mira_3_4/mira.* tools/mira_3_4/tool_dependencies.xml
3
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
76
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
77 Check this worked:
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
78
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
79 $ tar -tzf mira_wrapper.tar.gz
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
80 tools/mira_3_4/mira.py
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
81 tools/mira_3_4/mira.txt
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
82 tools/mira_3_4/mira.xml
4
03743667463c Uploaded v0.0.7, take 2, included the tool_dependencies.xml file
peterjc
parents: 3
diff changeset
83 tools/mira_3_4/tool_dependencies.xml
3
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
84
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
85
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
86 Licence (MIT/BSD style)
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
87 =======================
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
88
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
89 Permission to use, copy, modify, and distribute this software and its
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
90 documentation with or without modifications and for any purpose and
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
91 without fee is hereby granted, provided that any copyright notices
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
92 appear in all copies and that both those copyright notices and this
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
93 permission notice appear in supporting documentation, and that the
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
94 names of the contributors or copyright holders not be used in
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
95 advertising or publicity pertaining to distribution of the software
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
96 without specific prior permission.
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
97
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
98 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
99 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
100 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
101 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
102 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
103 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
104 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
c1c7d6f726b0 Uploaded v0.0.7 take 1, attempts automated installation of the MIRA binary.
peterjc
parents:
diff changeset
105 OR PERFORMANCE OF THIS SOFTWARE.