diff tools/align_back_trans/README.rst @ 2:9fbf29a8c12b draft

v0.0.6 use format_source; v0.0.5 more explicit error msg, citation info
author peterjc
date Wed, 05 Aug 2015 10:52:56 -0400
parents ec202446408a
children de803005027f
line wrap: on
line diff
--- a/tools/align_back_trans/README.rst	Wed Jun 04 08:42:23 2014 -0400
+++ b/tools/align_back_trans/README.rst	Wed Aug 05 10:52:56 2015 -0400
@@ -1,7 +1,7 @@
 Galaxy tool to back-translate a protein alignment to nucleotides
 ================================================================
 
-This tool is copyright 2012-2014 by Peter Cock, The James Hutton Institute
+This tool is copyright 2012-2015 by Peter Cock, The James Hutton Institute
 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
 See the licence text below (MIT licence).
 
@@ -43,11 +43,12 @@
 
     <tool file="align_back_trans/align_back_trans.xml" />
 
-You will also need to install Biopython 1.62 or later. If you want to run
-the unit tests, include this line in ``tools_conf.xml.sample`` and the sample
-FASTA files under the ``test-data`` directory. Then::
+You will also need to install Biopython 1.62 or later.
 
-    ./run_functional_tests.sh -id align_back_trans
+If you wish to run the unit tests, also	move/copy the ``test-data/`` files
+under Galaxy's ``test-data/`` folder. Then::
+
+    ./run_tests.sh -id align_back_trans
 
 That's it.
 
@@ -63,6 +64,11 @@
 v0.0.3  - First official release
 v0.0.4  - Simplified XML to apply input format to output data.
         - Fixed error message when sequence length not a multiple of three.
+v0.0.5  - More explicit error messages when seqences lengths do not match.
+        - Tool definition now embeds citation information.
+v0.0.6  - Reorder XML elements (internal change only).
+        - Use ``format_source=...`` tag.
+        - Planemo for Tool Shed upload (``.shed.yml``, internal change only).
 ======= ======================================================================
 
 
@@ -75,22 +81,31 @@
 With the addition of a Galaxy wrapper, developement moved here:
 https://github.com/peterjc/pico_galaxy/tree/master/tools/align_back_trans
 
-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)::
+
+    $ planemo shed_update --shed_target testtoolshed --check_diff ~/repositories/pico_galaxy/tools/align_back_trans/
+    ...
+
+or::
 
-    $ tar -czf align_back_trans.tar.gz tools/align_back_trans/README.rst tools/align_back_trans/align_back_trans.py tools/align_back_trans/align_back_trans.xml tools/align_back_trans/tool_dependencies.xml test-data/demo_nucs.fasta test-data/demo_nucs_trailing_stop.fasta test-data/demo_prot_align.fasta test-data/demo_nuc_align.fasta
+    $ planemo shed_update --shed_target toolshed --check_diff ~/repositories/pico_galaxy/tools/align_back_trans/
+    ...
+
+To just build and check the tar ball, use::
 
-Check this worked::
-
-    $ tar -tzf align_back_trans.tar.gz
+    $ planemo shed_upload --tar_only  ~/repositories/pico_galaxy/tools/align_back_trans/
+    ...
+    $ tar -tzf shed_upload.tar.gz 
+    test-data/demo_nucs.fasta
+    test-data/demo_nucs_trailing_stop.fasta
+    test-data/demo_prot_align.fasta
+    test-data/demo_nuc_align.fasta
     tools/align_back_trans/README.rst
     tools/align_back_trans/align_back_trans.py
     tools/align_back_trans/align_back_trans.xml
     tools/align_back_trans/tool_dependencies.xml
-    test-data/demo_nucs.fasta
-    test-data/demo_nucs_trailing_stop.fasta
-    test-data/demo_prot_align.fasta
-    test-data/demo_nuc_align.fasta
 
 
 Licence (MIT)