NAME

       Bio::Tools::PSort::Pathway - an object used to define the pathway that is traversed while doing a psort
       analysis.

SYNOPSIS

           $pathway = new Bio::Tools::PSort::Pathway('-path' => [ ... ]);

           @results = $pathway->traverse($seq);

DESCRIPTION

       The Pathway object is used to describe the pathway that is traversed while performing a psort analysis.
       Traditional psort methods [1] involved traversing a binary tree, where at every node an analysis was
       performed, and based on the result, control was directed down one of the two branches.  This version of
       PSort maintains the ability to define binary tree pathways, but allows them to be defined at runtime
       and/or loaded from a configuration file.

       Since the Pathway modules interface for defining new trees is rather low level, it is recommended that
       end users use either of the Bio::Tools::PSort::Pathway::Perl or Bio::Tools::PSort::Pathway::XML modules
       to create a binary tree.

       [1] As described in the paper 'Expert System for Predicting the Protein Localization Sites in Gram-
       Negative Bacteria' by Kenta Nakai and Minoru Kanehisa.

CONSTRUCTOR

           $pathway = new Bio::Tools::PSort::Pathway('-path' => [ ... ]);

       The constructor for the Pathway object accepts a single named parameter, '-path', which is an arrayref
       containing a description of the pathway.  Each node in the pathway is represented by an array ref
       containing 1 to 4 elements, which are in order, a reference to a Bio::Tools::PSort::ModuleI subclass, a
       reference to a subroutine, and two other node structures which will be executed if the subroutine returns
       either true or false values.

       Upon arriving at a node in the tree, the module is first run on the sequence being analyzed, and it's
       results is passed to the subroutine.  If the subroutine returns true, then the traversal continues with
       the third parameter, another tree node, otherwise traversal is sent down the fourth parameter, which is
       also another node in the tree.

       For example:

           $mod1 = new Bio::Tools::PSort::Module::Regexp();
           $mod2 = new Bio::Tools::PSort::Module::SCLBLAST();
           $mod3 = new Bio::Tools::PSort::Module::SPaseI();

           $func = sub {
                     my $res = shift;

                     return ($res->score()->{cyoplasm} > 0.50);
                   };

           $path = [$mod1, $func, [$mod2], [$mod3]];

           $pathway = new Bio::Tools::PSort::Pathway('-path' => $path);

       This example describes a simple tree with three nodes.  The first node consists of the Regular Expression
       module.  If the result returned from the Regexp module has score higher that 0.50 for the cytoplasm
       localization, then the subroutine will return true, and control flow will be directed to the SCLBLAST
       module.  If the score is less than or equal to 0.50, the control flow will be sent to the SPaseI module.

METHODS

           @results = $pathway->traverse($seq);

       The traverse method is used to send a sequence down the pathway.  An array of Bio::Tools::PSort::Score
       object is returned (each module returns a single Score object, they are collected as the pathway is
       traversed and returned as a group).

SEE ALSO

       Bio::Tools::PSort, Bio::Tools::PSort::ModuleI, Bio::Tools::PSort::Score,
       Bio::Tools::PSort::Pathway::Perl, Bio::Tools::PSort::Pathway::XML

AUTHOR

        Fiona Brinkman, Cory Spencer <psort-list@sfu.ca>
        Brinkman Laboratory, Simon Fraser University, BC, CANADA

OVERVIEW

       PSORT-B is described in Gardy, J.L. et al (2003). PSORT-B: improving protein subcellular localization
       prediction for Gram-negative bacteria. Nuc Acids Res 31(13):3613-17. Please cite this publication if you
       use PSORT-B in your research.

       The standalone version of PSORT-B is distributed under the GNU General Public Licence (Gnu GPL) (see the
       LICENSE file included in the download) by the Brinkman Laboratory, Simon Fraser University, Burnaby,
       B.C., Canada.

       This standalone version of PSORT-B has initially been developed for the Linux environment.

       This document describes the installation of the PSORT-B version 1.1.4 command line program and the PSORT-
       B server packages. For most purposes, following the installation instructions for the command line
       version will be sufficient.

       For further information, please contact psort-mail@sfu.ca.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU
       General Public License as published by the Free Software Foundation; either version 2 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
       the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
       License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write
       to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA