Mercurial > repos > peterjc > mira_assembler
annotate tools/mira3/README.rst @ 12:63ebe9726219 draft default tip
v0.0.11 move dependency to package_mira_3_4_1_1 etc
author | peterjc |
---|---|
date | Wed, 05 Aug 2015 11:28:05 -0400 |
parents | e59904c855ae |
children |
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 |
11
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
20 install the precompiled binary for MIRA v3.4.1.1 for the Galaxy wrapper, |
10
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 |
11
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
29 * ``mira.py`` (the Python script) |
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
30 * ``mira.xml`` (the Galaxy tool definition) |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
31 |
11
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
32 The suggested location is a new ``tools/mira3`` folder. You will also need to |
12 | 33 modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool by adding |
34 the line:: | |
35 | |
36 <tool file="mira3/mira.xml" /> | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
37 |
12 | 38 If you wish to run the unit tests, also move/copy the ``test-data/`` files |
39 under Galaxy's ``test-data/`` folder. Then:: | |
40 | |
41 $ ./run_tests -id mira_assembler | |
10
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 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
|
44 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
45 * http://chevreux.org/projects_mira.html |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
46 * http://sourceforge.net/projects/mira-assembler/ |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
47 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
48 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
|
49 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
|
50 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
|
51 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
|
52 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
|
53 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
54 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
55 History |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
56 ======= |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
57 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
58 ======= ====================================================================== |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
59 Version Changes |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
60 ------- ---------------------------------------------------------------------- |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
61 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
|
62 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
|
63 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
|
64 (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
|
65 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
|
66 - 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
|
67 - 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
|
68 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
|
69 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
|
70 version and the MIRA version being used. |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
71 - 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
|
72 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
|
73 - 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
|
74 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
|
75 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
|
76 - 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
|
77 - Use reStructuredText for this README file. |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
78 - Adopted standard MIT licence. |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
79 - Updated citation information (Cock et al. 2013). |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
80 - 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
|
81 v0.0.9 - Renamed folder mira_assembler to mira3 (see also MIRA 4 wrapper). |
11
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
82 - Correct path issue in automated dependency installation. |
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
83 v0.0.10 - Added a functional test. |
e59904c855ae
Uploaded v0.0.10, adds a test and updated download URL
peterjc
parents:
10
diff
changeset
|
84 - Updated URL for automated installation of MIRA v3.4.1.1 |
12 | 85 v0.0.11 - Tool definition now embeds citation information. |
86 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). | |
87 - MIRA 3.4.1.1 dependency now declared via dedicated Tool Shed package. | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
88 ======= ====================================================================== |
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 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
91 Developers |
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 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
94 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
|
95 http://bitbucket.org/peterjc/galaxy-central/src/tools |
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 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
|
98 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
|
99 |
12 | 100 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
101 Planemo commands (which requires you have set your Tool Shed access details in | |
102 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
103 |
12 | 104 $ planemo shed_update --shed_target testtoolshed --check_diff ~/repositories/pico_galaxy/tools/mira3/ |
105 ... | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
106 |
12 | 107 or:: |
108 | |
109 $ planemo shed_update --shed_target toolshed --check_diff ~/repositories/pico_galaxy/tools/mira3/ | |
110 ... | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
111 |
12 | 112 To just build and check the tar ball, use:: |
113 | |
114 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/mira3/ | |
115 ... | |
116 $ tar -tzf shed_upload.tar.gz | |
117 test-data/empty_file.dat | |
118 test-data/tvc_contigs.fasta | |
119 test-data/tvc_mini.fastq | |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
120 tools/mira3/README.rst |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
121 tools/mira3/mira.py |
12 | 122 tools/mira3/mira.xml |
10
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
123 tools/mira3/tool_dependencies.xml |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
124 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
125 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
126 Licence (MIT) |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
127 ============= |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
128 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
129 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
|
130 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
|
131 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
|
132 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
|
133 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
|
134 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
|
135 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
136 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
|
137 all copies or substantial portions of the Software. |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
138 |
a2fb1e67bd11
Uploaded v0.0.9, correct path in dependency installation; renamed folder
peterjc
parents:
diff
changeset
|
139 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
|
140 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
|
141 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
|
142 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
|
143 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
|
144 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
|
145 THE SOFTWARE. |