Mercurial > repos > peterjc > mira_assembler

annotate tools/mira_3_4/README.rst @ 9:b1d60b46d282 draft

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