annotate tools/protein_analysis/README.rst @ 18:eb6ac44d4b8e draft

Suite v0.2.8, record Promoter 2 verion + misc internal updates

This package contains Galaxy wrappers for a selection of standalone command
line protein analysis tools:

* SignalP 3.0, THMHMM 2.0, Promoter 2.0 from the Center for Biological
  Sequence Analysis at the Technical University of Denmark,
  http://www.cbs.dtu.dk/cbs/

* WoLF PSORT v0.2 from http://wolfpsort.org/

* PSORTb v3 from http://www.psort.org/downloads/index.html

Also, the RXLR motif tool uses SignalP 3.0 and HMMER 2.3.2 internally.

To use these Galaxy wrappers you must first install the command line tools.
At the time of writing they are all free for academic use, or open source.

These wrappers are copyright 2010-2015 by Peter Cock, James Hutton Institute
(formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
Contributions/revisions copyright 2011 Konrad Paszkiewicz. All rights reserved.
See the included LICENCE file for details (MIT open source licence).

The wrappers are available from the Galaxy Tool Shed
http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp 

Citation
========

If you use any of these Galaxy tools in work leading to a scientific
publication, in addition to citing the invididual underlying tools, please cite:

Peter Cock, Bjoern Gruening, Konrad Paszkiewicz and Leighton Pritchard (2013).
Galaxy tools and workflows for sequence analysis with applications
in molecular plant pathology. PeerJ 1:e167
http://dx.doi.org/10.7717/peerj.167

Full reference information is included in the help text for each tool.


Requirements
============

First install those command line tools you wish to use the wrappers for:

1. Install the command line version of SignalP 3.0 and ensure ``signalp`` is
   on the PATH, see: http://www.cbs.dtu.dk/services/SignalP/

2. Install the command line version of TMHMM 2.0 and ensure ``tmhmm`` is on
   the PATH, see: http://www.cbs.dtu.dk/services/TMHMM/

3. Install the command line version of Promoter 2.0 and ensure ``promoter`` is
   on the PATH, see: http://www.cbs.dtu.dk/services/Promoter

4. Install the WoLF PSORT v0.2 package, and ensure ``runWolfPsortSummary``
   is on the PATH (we use an extra wrapper script to change to the WoLF PSORT
   directory, run runWolfPsortSummary, and then change back to the original
   directory), see: http://wolfpsort.org/WoLFPSORT_package/version0.2/

5. Install hmmsearch from HMMER 2.3.2 (the last stable release of HMMER 2)
   but put it on the path under the name ``hmmsearch2`` (allowing it to
   co-exist with HMMER 3), or edit ``rlxr_motif.py`` accordingly.

Verify each of the tools is installed and working from the command line
(when logged in as the Galaxy user if appropriate).


Manual Installation
===================

1. Create a folder ``tools/protein_analysis`` under your Galaxy installation.
   This folder name is not critical, and can be changed if desired - you
   must update the paths used in ``tool_conf.xml`` to match.

2. Copy/move the following files (from this archive) there:

   * ``tmhmm2.xml`` (Galaxy tool definition)
   * ``tmhmm2.py`` (Python wrapper script)

   * ``signalp3.xml`` (Galaxy tool definition)
   * ``signalp3.py`` (Python wrapper script)

   * ``promoter2.xml`` (Galaxy tool definition)
   * ``promoter2.py`` (Python wrapper script)

   * ``psortb.xml`` (Galaxy tool definition)
   * ``psortb.py`` (Python wrapper script)

   * ``wolf_psort.xml`` (Galaxy tool definition)
   * ``wolf_psort.py`` (Python wrapper script)

   * ``rxlr_motifs.xml`` (Galaxy tool definition)
   * ``rxlr_motifs.py`` (Python script)

   * ``seq_analysis_utils.py`` (shared Python code)
   * ``LICENCE``
   * ``README.rst`` (this file)

3. Edit your Galaxy conjuration file ``tool_conf.xml`` to include the
   new tools by adding::

    <section name="Protein sequence analysis" id="protein_analysis">
      <tool file="protein_analysis/tmhmm2.xml" />
      <tool file="protein_analysis/signalp3.xml" />
      <tool file="protein_analysis/psortb.xml" />
      <tool file="protein_analysis/wolf_psort.xml" />
      <tool file="protein_analysis/rxlr_motifs.xml" />
    </section>
    <section name="Nucleotide sequence analysis" id="nucleotide_analysis">
      <tool file="protein_analysis/promoter2.xml" />
    </section>

   Leave out the lines for any tools you do not wish to use in Galaxy.

4. Copy/move the ``test-data/*`` files (from this archive) to Galaxy's
   subfolder ``test-data/``.

5. Run the Galaxy functional tests for these new wrappers with::

    $ ./run_tests.sh -id tmhmm2
    $ ./run_tests.sh -id signalp3
    $ ./run_tests.sh -id Psortb
    $ ./run_tests.sh -id rxlr_motifs

   Alternatively, this should work (assuming you left the seciont name and id
   as shown above in your XML file ``tool_conf.xml``)::

    $ ./run_tests.sh -sid Protein_sequence_analysis-protein_analysis

   To check the section ID expected, use:

    $ ./run_tests.sh -list

6. Restart Galaxy and check the new tools are shown and work.


History
=======

======= ======================================================================
Version Changes
------- ----------------------------------------------------------------------
v0.0.1  - Initial release
v0.0.2  - Corrected some typos in the help text
        - Renamed test output file to use Galaxy convention of ``*.tabular``
v0.0.3  - Check for tmhmm2 silent failures (no output)
        - Additional unit tests
v0.0.4  - Ignore comment lines in tmhmm2 output.
v0.0.5  - Explicitly request tmhmm short output (may not be the default)
v0.0.6  - Improvement to how sub-jobs are run (should be faster)
v0.0.7  - Change SignalP default truncation from 60 to 70 to match the
          SignalP webservice.
v0.0.8  - Added WoLF PSORT wrapper to the suite.
v0.0.9  - Added our RXLR motifs tool to the suite.
v0.1.0  - Added Promoter 2.0 wrapper (similar to SignalP & TMHMM wrappers)
        - Support Galaxy's ``<parallelism>`` tag for SignalP, TMHMM & Promoter
v0.1.1  - Fixed an error in the header of the tabular output from Promoter
v0.1.2  - Use the new <stdio> settings in the XML wrappers to catch errors
        - Use SGE style ``$NSLOTS`` for thread count (otherwise default to 4)
v0.1.3  - Added missing file ``whisson_et_al_rxlr_eer_cropped.hmm`` to Tool Shed
v0.2.0  - Added PSORTb wrapper to the suite, based on earlier work
          contributed by Konrad Paszkiewicz.
v0.2.1  - Use a script to create the Tool Shed tar-ball (removed some stray
          files accidentally included previously via a wildcard).
v0.2.2  - Include missing test files.
v0.2.3  - Added unit tests for WoLF PSORT.
v0.2.4  - Added unit tests for Promoter 2
v0.2.5  - Link to Tool Shed added to help text and this documentation.
        - More unit tests.
        - Fixed bug with RXLR tool and empty FASTA files.
        - Fixed typo in the RXLR tool help text.
        - Updated citation information (Cock et al. 2013).
        - Adopted standard MIT licence.
        - Use reStructuredText for this README file.
        - Development moved to GitHub, https://github.com/peterjc/pico_galaxy
v0.2.6  - Use the new ``$GALAXY_SLOTS`` environment variable for thread count.
        - Updated the ``suite_config.xml`` file (overdue).
        - Tool definition now embeds citation information.
v0.2.7  - Style cleanup in Python scripts.
v0.2.8  - Reorder XML elements (internal change only).
        - Planemo for Tool Shed upload (``.shed.yml``, internal change only).
        - Record version of Promoter 2 via ``<version_command>``.
======= ======================================================================


Developers
==========

This script and other tools were initially developed on the following hg branches:
http://bitbucket.org/peterjc/galaxy-central/src/seq_analysis
http://bitbucket.org/peterjc/galaxy-central/src/tools

Development has now moved to a dedicated GitHub repository:
https://github.com/peterjc/pico_galaxy/tree/master/tools


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 -t testtoolshed --check_diff ~/repositories/pico_galaxy/tools/protein_analysis/
    ...

or::

    $ planemo shed_update -t toolshed --check_diff ~/repositories/pico_galaxy/tools/protein_analysis/
    ...

To just build and check the tar ball, use::

    $ planemo shed_upload --tar_only  ~/repositories/pico_galaxy/tools/protein_analysis/
    ...
    $ tar -tzf shed_upload.tar.gz 
    test-data/Adenovirus.fasta
    test-data/Adenovirus.promoter2.tabular
    test-data/empty.fasta
    test-data/empty_promoter2.tabular
    test-data/empty_psortb_terse.tabular
    test-data/empty_rxlr.Bhattacharjee2006.tabular
    test-data/empty_rxlr.Whisson2007.tabular
    test-data/empty_rxlr.Win2007.tabular
    test-data/empty_signalp3.tabular
    test-data/empty_tmhmm2.tabular
    test-data/empty_wolf_psort.tabular
    test-data/four_human_proteins.fasta
    test-data/four_human_proteins.signalp3.tabular
    test-data/four_human_proteins.tmhmm2.tabular
    test-data/four_human_proteins.wolf_psort.tabular
    test-data/k12_ten_proteins.fasta
    test-data/k12_ten_proteins_psortb_p_terse.tabular
    test-data/rxlr_win_et_al_2007.fasta
    test-data/rxlr_win_et_al_2007.tabular
    test-data/rxlr_win_et_al_2007_sp3.tabular
    tools/protein_analysis/LICENSE.txt
    tools/protein_analysis/README.rst
    tools/protein_analysis/promoter2.py
    tools/protein_analysis/promoter2.xml
    tools/protein_analysis/psortb.py
    tools/protein_analysis/psortb.xml
    tools/protein_analysis/rxlr_motifs.py
    tools/protein_analysis/rxlr_motifs.xml
    tools/protein_analysis/seq_analysis_utils.py
    tools/protein_analysis/signalp3.py
    tools/protein_analysis/signalp3.xml
    tools/protein_analysis/suite_config.xml
    tools/protein_analysis/tmhmm2.py
    tools/protein_analysis/tmhmm2.xml
    tools/protein_analysis/whisson_et_al_rxlr_eer_cropped.hmm
    tools/protein_analysis/wolf_psort.py
    tools/protein_analysis/wolf_psort.xml

This simplifies ensuring a consistent set of files is bundled each time,
including all the relevant test files.