.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Bio::Tools::PSort::ModuleI 3pm" .TH Bio::Tools::PSort::ModuleI 3pm "2018-11-01" "perl v5.28.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Bio::Tools::PSort::ModuleI \- an interface class that all PSort modules should derive implement. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& package Bio::Tools::PSort::Module::Foo; \& \& use Bio::Tools::PSort::Module; \& \& use vars qw(@ISA); \& @ISA = qw(Bio::Tools::PSort::Module; \& \& ... \& ... \& \& 1; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The module object contains functionality common to all PSort modules. This class is not intended to be instantiated on it's own, it only provides functionality common to all PSort modules. .SH "METHODS" .IX Header "METHODS" .Vb 1 \& $result = $module\->run($seq); .Ve .PP The run method must be overridden in all derived classes. \fBrun()\fR should accept a Bio::Tools::Seq object, and perform whatever analysis the module provides on the sequence, returning a bio::PSort::Scort object upon completion. .SH "SEE ALSO" .IX Header "SEE ALSO" Bio::Tools::PSort, Bio::Tools::PSort::Pathway, Bio::Tools::PSort::Score .SH "AUTHOR" .IX Header "AUTHOR" .Vb 2 \& Fiona Brinkman, Cory Spencer \& Brinkman Laboratory, Simon Fraser University, BC, CANADA .Ve .SH "OVERVIEW" .IX Header "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. .PP The standalone version of PSORT-B is distributed under the \s-1GNU\s0 General Public Licence (Gnu \s-1GPL\s0) (see the \s-1LICENSE\s0 file included in the download) by the Brinkman Laboratory, Simon Fraser University, Burnaby, B.C., Canada. .PP This standalone version of PSORT-B has initially been developed for the Linux environment. .PP 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. .PP For further information, please contact psort\-mail@sfu.ca. .SH "LICENCE" .IX Header "LICENCE" This program is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0 02111\-1307 \s-1USA\s0