Mercurial > repos > peterjc > mira_assembler

annotate tools/mira3/README.rst @ 15:fbe9139eb74b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.10b, updated download URL
author peterjc
date Mon, 21 Apr 2014 06:57:45 -0400
parents 880551558151
children f74bc0420db4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
5b0af75dfe5a 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)
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
2 ===================================================
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
3
5b0af75dfe5a 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
5b0af75dfe5a 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.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
6 See the licence text below (MIT licence).
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
7
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
10 separated file for use in Galaxy).
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
11
5b0af75dfe5a 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:
5b0af75dfe5a 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
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
14
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
15
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
16 Automated Installation
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
17 ======================
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
18
5b0af75dfe5a 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
15
fbe9139eb74b Uploaded v0.0.10b, updated download URL
peterjc
parents: 14
diff changeset
20 install the precompiled binary for MIRA v3.4.1.1 for the Galaxy wrapper,
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
21 and run any tests.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
22
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
23
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
24 Manual Installation
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
25 ===================
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
26
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
27 There are just two Galaxy files to install:
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
28
13
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
29 * ``mira.py`` (the Python script)
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
30 * ``mira.xml`` (the Galaxy tool definition)
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
31
13
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
32 The suggested location is a new ``tools/mira3`` folder. You will also need to
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
33 modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool, and also do
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
34 this to ``tools_conf.xml.sample`` in order to run any tests::
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
35
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
36 <tool file="mira3/mira.xml" />
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
37
5b0af75dfe5a 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:
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
39
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
40 * http://chevreux.org/projects_mira.html
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
41 * http://sourceforge.net/projects/mira-assembler/
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
42
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a 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.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
48
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
49
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
50 History
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
51 =======
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
52
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
53 ======= ======================================================================
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
54 Version Changes
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
55 ------- ----------------------------------------------------------------------
5b0af75dfe5a 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)
5b0af75dfe5a 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)
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a 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)
5b0af75dfe5a 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
5b0af75dfe5a 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)
5b0af75dfe5a 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
5b0af75dfe5a 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
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
65 version and the MIRA version being used.
5b0af75dfe5a 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)
5b0af75dfe5a 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
5b0af75dfe5a 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)
5b0af75dfe5a 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.
5b0af75dfe5a 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).
5b0af75dfe5a 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.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
72 - Use reStructuredText for this README file.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
73 - Adopted standard MIT licence.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
74 - Updated citation information (Cock et al. 2013).
5b0af75dfe5a 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
5b0af75dfe5a 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).
13
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
77 - Correct path issue in automated dependency installation.
8a05c6b852c3 Uploaded v0.0.10, adding test
peterjc
parents: 12
diff changeset
78 v0.0.10 - Added a functional test.
15
fbe9139eb74b Uploaded v0.0.10b, updated download URL
peterjc
parents: 14
diff changeset
79 - Updated URL for automated installation of MIRA v3.4.1.1
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
80 ======= ======================================================================
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
81
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
82
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
83 Developers
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
84 ==========
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
85
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
86 This script and related tools were initially developed on the following hg branch:
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
87 http://bitbucket.org/peterjc/galaxy-central/src/tools
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
88
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
89 Development has now moved to a dedicated GitHub repository:
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
90 https://github.com/peterjc/pico_galaxy/tree/master/tools/mira_3_4
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
91
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
92 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
93 the following command from the Galaxy root folder::
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
94
14
880551558151 Uploaded v0.0.10a, adding missing test file
peterjc
parents: 13
diff changeset
95 $ 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 test-data/empty_file.dat
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
96
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
97 Check this worked::
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
98
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
99 $ tar -tzf mira3_wrapper.tar.gz
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
100 tools/mira3/README.rst
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
101 tools/mira3/mira.xml
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
102 tools/mira3/mira.py
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
103 tools/mira3/tool_dependencies.xml
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
104 test-data/tvc_mini.fastq
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
105 test-data/tvc_contigs.fasta
14
880551558151 Uploaded v0.0.10a, adding missing test file
peterjc
parents: 13
diff changeset
106 test-data/empty_file.dat
12
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
107
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
108
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
109 Licence (MIT)
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
110 =============
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
111
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
112 Permission is hereby granted, free of charge, to any person obtaining a copy
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
113 of this software and associated documentation files (the "Software"), to deal
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
114 in the Software without restriction, including without limitation the rights
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
115 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
116 copies of the Software, and to permit persons to whom the Software is
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
117 furnished to do so, subject to the following conditions:
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
118
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
119 The above copyright notice and this permission notice shall be included in
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
120 all copies or substantial portions of the Software.
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
121
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
122 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
123 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
124 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
125 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
126 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
127 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
5b0af75dfe5a Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff changeset
128 THE SOFTWARE.