Mercurial > repos > peterjc > mira_assembler

annotate tools/mira_3_4/README.rst @ 9:5573d802e431 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
author peterjc
date Wed, 18 Sep 2013 06:22:19 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
1 Galaxy tool to wrap the MIRA sequence assembly program (v3.4)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
2 =============================================================
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
3
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
4 This tool is copyright 2011-2013 by Peter Cock, The James Hutton Institute
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
6 See the licence text below (MIT licence).
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
7
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
8 This tool is a short Python script (to collect the MIRA output and move it
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
9 to where Galaxy expects the files, and convert MIRA's TCS file into a tab
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
10 separated file for use in Galaxy).
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
11
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
12 It is available from the Galaxy Tool Shed at:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
13 http://toolshed.g2.bx.psu.edu/view/peterjc/mira_assembler
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
14
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
15
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
16 Automated Installation
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
17 ======================
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
18
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
19 This should be straightforward, Galaxy should automatically download and
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
20 install the precompiled binary for MIRA v3.4.0 for the Galaxy wrapper,
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
21 and run any tests.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
22
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
23
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
24 Manual Installation
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
25 ===================
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
26
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
27 There are just two Galaxy files to install:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
28
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
29 * mira.py (the Python script)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
30 * mira.xml (the Galaxy tool definition)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
31
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
32 The suggested location is a new tools/mira_3_4 folder. You will also need to
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
33 modify the tools_conf.xml file to tell Galaxy to offer the tool, and also do
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
34 this to tools_conf.xml.sample in order to run any tests::
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
35
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
36 <tool file="mira_3_4/mira.xml" />
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
37
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
38 You will also need to install MIRA, we used version 3.4.1.1. See:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
39
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
40 * http://chevreux.org/projects_mira.html
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
41 * http://sourceforge.net/projects/mira-assembler/
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
42
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
43 WARNING: This tool was developed to construct viral genome assembly and
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
44 mapping pipelines, for which the run time and memory requirements are
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
45 negligible. For larger tasks, be aware that MIRA can require vast amounts
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
46 of RAM and run-times of over a week are possible. This tool wrapper makes
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
47 no attempt to spot and reject such large jobs.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
48
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
49
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
50 History
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
51 =======
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
52
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
53 ======= ======================================================================
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
54 Version Changes
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
55 ------- ----------------------------------------------------------------------
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
56 v0.0.1 - Initial version (working prototype, using MIRA 3.2.1)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
57 v0.0.2 - Improve capture of stdout/stderr (should see it as it runs)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
58 v0.0.3 - Support Ion Torrent reads, now requires MIRA 3.4.0 or later
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
59 (some other switches changed, e.g. -OUT rrol to rrot, which
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
60 means the wrapper no longer works with MIRA 3.2.x)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
61 - The contig summary file (TCS file) was removed in MIRA 3.4
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
62 - Report all missing output files (not just first missing one)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
63 v0.0.4 - Fix problem with backbone arguments inroduced in v0.0.3
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
64 v0.0.5 - Implement the <version_command> tag to record the wrapper
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
65 version and the MIRA version being used.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
66 - Check using MIRA 3.4 (later versions have a different API)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
67 v0.0.6 - Tell MIRA to use /tmp for temporary files
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
68 - Tell MIRA to ignore long read names (otherwise it aborts)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
69 v0.0.7 - Automated installation of the 64 bit Linux MIRA binary.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
70 v0.0.8 - Basic unit test added (but commented out due to Galaxy issue).
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
71 - Link to Tool Shed added to help text and this documentation.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
72 - Use reStructuredText for this README file.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
73 - Adopted standard MIT licence.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
74 - Updated citation information (Cock et al. 2013).
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
75 - Development moved to GitHub, https://github.com/peterjc/pico_galaxy
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
76 ======= ======================================================================
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
77
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
78
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
79 Developers
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
80 ==========
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
81
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
82 This script and related tools were initially developed on the following hg branch:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
83 http://bitbucket.org/peterjc/galaxy-central/src/tools
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
84
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
85 Development has now moved to a dedicated GitHub repository:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
86 https://github.com/peterjc/pico_galaxy/tree/master/tools/mira_3_4
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
87
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
88 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
89 the following command from the Galaxy root folder::
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
90
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
91 $ tar -czf mira_wrapper.tar.gz tools/mira_3_4/README.rst tools/mira_3_4/mira.xml tools/mira_3_4/mira.py tools/mira_3_4/tool_dependencies.xml test-data/tvc_mini.fastq test-data/tvc_contigs.fasta
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
92
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
93 Check this worked::
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
94
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
95 $ tar -tzf mira_wrapper.tar.gz
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
96 tools/mira_3_4/README.rst
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
97 tools/mira_3_4/mira.xml
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
98 tools/mira_3_4/mira.py
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
99 tools/mira_3_4/tool_dependencies.xml
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
100 test-data/tvc_mini.fastq
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
101 test-data/tvc_contigs.fasta
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
102
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
103
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
104 Licence (MIT)
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
105 =============
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
106
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
107 Permission is hereby granted, free of charge, to any person obtaining a copy
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
108 of this software and associated documentation files (the "Software"), to deal
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
109 in the Software without restriction, including without limitation the rights
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
110 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
111 copies of the Software, and to permit persons to whom the Software is
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
112 furnished to do so, subject to the following conditions:
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
113
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
114 The above copyright notice and this permission notice shall be included in
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
115 all copies or substantial portions of the Software.
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
116
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
117 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
118 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
119 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
120 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
121 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
122 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
5573d802e431 Uploaded v0.0.8, MIT licence, RST for README, citation information, development moved to GitHub.
peterjc
parents:
diff changeset
123 THE SOFTWARE.