diff tools/mira4/README.rst @ 21:4abe8d59a438 draft

Uploaded v0.0.4 preview 1; fix getting BAM without MAF
author peterjc
date Tue, 28 Oct 2014 08:29:59 -0400
parents aeb3e35f8236
children
line wrap: on
line diff
--- a/tools/mira4/README.rst	Tue Jun 10 10:11:58 2014 -0400
+++ b/tools/mira4/README.rst	Tue Oct 28 08:29:59 2014 -0400
@@ -44,9 +44,11 @@
 
 * ``mira4_de_novo.xml`` (the Galaxy tool definition for de novo usage)
 * ``mira4_mapping.xml`` (the Galaxy tool definition for mapping usage)
+* ``mira4_convert.xml`` (the Galaxy tool definition for converting MIRA files)
 * ``mira4_bait.xml`` (the Galaxy tool definition for mirabait)
 * ``mira4.py`` (the Python wrapper script)
-* ``mira_bait.py`` (the Python wrapper script for mirabait)
+* ``mira4_convert.py`` (the Python wrapper script for miraconvert)
+* ``mira4_bait.py`` (the Python wrapper script for mirabait)
 * ``mira4_validator.py`` (the XML parameter validation script)
 
 The suggested location is a new ``tools/mira4`` folder. You will also need to
@@ -75,6 +77,7 @@
     $ ./run_functional_tests.sh -id mira_4_0_bait
     $ ./run_functional_tests.sh -id mira_4_0_de_novo
     $ ./run_functional_tests.sh -id mira_4_0_mapping
+    $ ./run_functional_tests.sh -id mira_4_0_convert
 
 
 History
@@ -93,6 +96,7 @@
 v0.0.3  - Updated to target MIRA 4.0.2
 v0.0.4  - Using optparse for the Python wrapper script API
         - Made MAF and BAM outputs optional
+        - Include wrapper for ``miraconvert``
 ======= ======================================================================
 
 
@@ -105,7 +109,7 @@
 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
 the following command from the Galaxy root folder::
 
-    $ tar -czf mira4_wrapper.tar.gz tools/mira4/README.rst tools/mira4/mira4_de_novo.xml tools/mira4/mira4_mapping.xml tools/mira4/mira4_bait.xml tools/mira4/mira4.py tools/mira4/mira4_make_bam.py tools/mira4/mira4_validator.py tools/mira4/mira4_bait.py tools/mira4/tool_dependencies.xml tools/mira4/repository_dependencies.xml test-data/U13small_m.fastq test-data/U13small_m.mira4_de_novo.fasta test-data/tvc_mini.fastq test-data/tvc_contigs.fasta test-data/tvc_map_ref_strain.fasta test-data/tvc_map_same_strain.fasta test-data/tvc_bait.fasta test-data/tvc_mini_bait_pos.fastq test-data/tvc_mini_bait_strict.fastq test-data/tvc_mini_bait_neg.fastq test-data/ecoli.fastq test-data/ecoli.mira4_de_novo.fasta test-data/empty_file.dat
+    $ tar -czf mira4_wrapper.tar.gz tools/mira4/README.rst tools/mira4/mira4_de_novo.xml tools/mira4/mira4_mapping.xml tools/mira4/mira4_bait.xml tools/mira4/mira4_convert.xml tools/mira4/mira4.py tools/mira4/mira4_make_bam.py tools/mira4/mira4_validator.py tools/mira4/mira4_convert.py tools/mira4/mira4_bait.py tools/mira4/tool_dependencies.xml tools/mira4/repository_dependencies.xml test-data/U13small_m.fastq test-data/U13small_m.mira4_de_novo.fasta test-data/tvc_mini.fastq test-data/tvc_contigs.fasta test-data/tvc_map_ref_strain.fasta test-data/tvc_map_same_strain.fasta test-data/tvc_bait.fasta test-data/tvc_mini_bait_pos.fastq test-data/tvc_mini_bait_strict.fastq test-data/tvc_mini_bait_neg.fastq test-data/ecoli.fastq test-data/ecoli.mira4_de_novo.fasta test-data/header.mira test-data/empty_file.dat
 
 Check this worked::
 
@@ -114,9 +118,11 @@
     tools/mira4/mira4_de_novo.xml
     tools/mira4/mira4_mapping.xml
     tools/mira4/mira4_bait.xml
+    tools/mira4/mira4_convert.xml
     tools/mira4/mira4.py
     tools/mira4/mira4_make_bam.py
     tools/mira4/mira4_validator.py
+    tools/mira4/mira4_convert.py
     tools/mira4/mira4_bait.py
     tools/mira4/tool_dependencies.xml
     tools/mira4/repository_dependencies.xml
@@ -132,6 +138,7 @@
     test-data/tvc_mini_bait_neg.fastq
     test-data/ecoli.fastq
     test-data/ecoli.mira4_de_novo.fasta
+    test-data/header.mira
     test-data/empty_file.dat