Bio::T...oduleI(3pm)

πŸ“¦
version 3.0.6 Β· 4 versions
, in ubuntu jammy

πŸ’– Bio::T...oduleI β€” the manual page, but make it make sense πŸ’–

okay so bestie, you're looking at Bio::T...oduleI(3pm) from the User Contributed Perl Documentation crew. Yes the title is literally abbreviated like that, we don't make the rules. Come sit, this one's short and sweet and honestly kind of iconic. ✨


🌸 NAME 🌸

Bio::Tools::PSort::ModuleI β€” an interface class that all PSort modules should derive implement.

(no I did not mistype that, that's fr fr what it says πŸ’…)


πŸ¦‹ SYNOPSIS πŸ¦‹

package Bio::Tools::PSort::Module::Foo;

use Bio::Tools::PSort::Module;

use vars qw(@ISA);
@ISA = qw(Bio::Tools::PSort::Module;

...
...

1;

yes the @ISA line is missing a closing paren, bestie, I'm just the messenger, I copy character for character and I do not fix. πŸ’€


πŸŽ€ DESCRIPTION πŸŽ€

So the module object is carrying all the functionality that every single PSort module has in common. That's the whole vibe. 🫢

lowkey important: this class is not meant to be instantiated on its own. it's not a main character, it's the supporting cast β€” it only exists to hand out the shared functionality to all the PSort modules.

✨ METHODS ✨

$result = $module->run($seq);

The run method is mandatory to override in all derived classes. no skipping, no shortcuts. πŸ’…

run() should accept a Bio::Tools::Seq object, do whatever analysis the module is about on that sequence, and then return a bio::PSort::Scort object when it's done. that's the deal. πŸ¦‹


πŸ‘‘ SEE ALSO πŸ‘‘

  • Bio::Tools::PSort
  • Bio::Tools::PSort::Pathway
  • Bio::Tools::PSort::Score

go read those next, bestie, that's your homework 🌈


🌸 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. (yes this is the "cite me" part, do it, it's giving academic integrity πŸŽ“)

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.


⭐ LICENCE ⭐

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


no cap on that warranty disclaimer bestie, it's shouting in all caps for a reason 😭

and that's the whole page!! this one was written by perl v5.34.0 on 2022-02-06, so shoutout to that version for keeping the receipts 🫢 mwah, go write your module, slay πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from