Mercurial > repos > peterjc > mira_assembler

annotate tools/sr_assembly/mira.txt @ 6:3e7eca1f5d04 draft

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