Mercurial > repos > peterjc > mira_assembler
diff 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 |
line wrap: on
line diff
--- a/tools/mira3/README.rst Wed Apr 30 07:21:57 2014 -0400 +++ b/tools/mira3/README.rst Wed Aug 05 11:28:05 2015 -0400 @@ -30,10 +30,15 @@ * ``mira.xml`` (the Galaxy tool definition) The suggested location is a new ``tools/mira3`` folder. You will also need to -modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool, and also do -this to ``tools_conf.xml.sample`` in order to run any tests:: +modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool by adding +the line:: + + <tool file="mira3/mira.xml" /> - <tool file="mira3/mira.xml" /> +If you wish to run the unit tests, also move/copy the ``test-data/`` files +under Galaxy's ``test-data/`` folder. Then:: + + $ ./run_tests -id mira_assembler You will also need to install MIRA, we used version 3.4.1.1. See: @@ -77,6 +82,9 @@ - Correct path issue in automated dependency installation. v0.0.10 - Added a functional test. - Updated URL for automated installation of MIRA v3.4.1.1 +v0.0.11 - Tool definition now embeds citation information. + - Planemo for Tool Shed upload (``.shed.yml``, internal change only). + - MIRA 3.4.1.1 dependency now declared via dedicated Tool Shed package. ======= ====================================================================== @@ -89,21 +97,30 @@ Development has now moved to a dedicated GitHub repository: https://github.com/peterjc/pico_galaxy/tree/master/tools/mira_3_4 -For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use -the following command from the Galaxy root folder:: +For pushing a release to the test or main "Galaxy Tool Shed", use the following +Planemo commands (which requires you have set your Tool Shed access details in +``~/.planemo.yml`` and that you have access rights on the Tool Shed):: - $ 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 + $ planemo shed_update --shed_target testtoolshed --check_diff ~/repositories/pico_galaxy/tools/mira3/ + ... -Check this worked:: +or:: + + $ planemo shed_update --shed_target toolshed --check_diff ~/repositories/pico_galaxy/tools/mira3/ + ... - $ tar -tzf mira3_wrapper.tar.gz +To just build and check the tar ball, use:: + + $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/mira3/ + ... + $ tar -tzf shed_upload.tar.gz + test-data/empty_file.dat + test-data/tvc_contigs.fasta + test-data/tvc_mini.fastq tools/mira3/README.rst - tools/mira3/mira.xml tools/mira3/mira.py + tools/mira3/mira.xml tools/mira3/tool_dependencies.xml - test-data/tvc_mini.fastq - test-data/tvc_contigs.fasta - test-data/empty_file.dat Licence (MIT)