Mercurial > repos > peterjc > effectivet3
diff tools/effectiveT3/README.rst @ 5:1ea715da1879 draft
Uploaded v0.0.13, embed citation, relax test for floating point differences
author | peterjc |
---|---|
date | Tue, 25 Nov 2014 08:28:24 -0500 |
parents | f7ce32e13bc6 |
children | 0f6eb4a75000 |
line wrap: on
line diff
--- a/tools/effectiveT3/README.rst Wed Sep 18 06:11:36 2013 -0400 +++ b/tools/effectiveT3/README.rst Tue Nov 25 08:28:24 2014 -0500 @@ -33,7 +33,7 @@ Manual Installation =================== -You can change the path by setting the environment variable EFFECTIVET3 to the +You can change the path by setting the environment variable ``$EFFECTIVET3`` to the relevant folder, but by default it expects the following files to be installed at these locations:: @@ -45,23 +45,23 @@ To install the wrapper copy or move the following files under the Galaxy tools folder, e.g. in a tools/effectiveT3 folder: -* effectiveT3.xml (the Galaxy tool definition) -* effectiveT3.py (the Python wrapper script) -* README.rst (this file) +* ``effectiveT3.xml`` (the Galaxy tool definition) +* ``effectiveT3.py`` (the Python wrapper script) +* ``README.rst`` (this file) -Also copy effectiveT3.loc.sample to effectiveT3.loc in the tool-data folder -(and edit if appropriate, e.g. to add or remove a model). +Also copy ``effectiveT3.loc.sample`` to ``effectiveT3.loc`` in the ``tool-data`` +folder (and edit if appropriate, e.g. to add or remove a model). -You will also need to modify the tools_conf.xml file to tell Galaxy to offer the +You will also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool. If you are using other protein analysis tools like TMHMM or SignalP, put it next to them. Just add the line:: <tool file="effectiveT3/effectiveT3.xml" /> -If you wish to run the unit tests, also add this to tools_conf.xml.sample -and move/copy the test-data files under Galaxy's test-data folder. Then:: +If you wish to run the unit tests, also move/copy the ``test-data/`` files +under Galaxy's ``test-data/`` folder. Then:: - $ ./run_functional_tests.sh -id effectiveT3 + $ ./run_tests.sh -id effectiveT3 That's it. @@ -84,6 +84,9 @@ - Use reStructuredText for this README file. - Updated citation information (Cock et al. 2013). - Development moved to GitHub, https://github.com/peterjc/pico_galaxy +v0.0.13 - Relax unit test to allow for small floating point score difference. + - Tool definition now embeds citation information. + - Fixed error handling in ``effectiveT3.py``. ======= ======================================================================