Mercurial > repos > peterjc > mira_assembler

annotate tools/mira3/README.rst @ 10:a2fb1e67bd11 draft

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