Bio::S...actory(3pm)

πŸ“¦
version 1.7.8 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– NAME πŸ’–

Bio::Search::Result::ResultFactory β€” bestie, it's a factory whose whole job is making Bio::Search::Result::ResultI objects. That's it. That's the girl. πŸ‘‘


✨ SYNOPSIS ✨

use Bio::Search::Result::ResultFactory;
my $factory = Bio::Search::Result::ResultFactory->new();
my $resultobj = $factory->create(@args);

Three lines and you're already slaying. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so the whole vibe here is hiding the object-creation process so that we can dynamically swap out which objects get created by the SearchIO parser, depending on what format of report we're parsing. It's giving indirection, it's giving flexibility, it's giving main character energy. 🌈

This object is for creating new Results. That's the assignment. πŸŽ€


πŸ“¬ FEEDBACK πŸ“¬

πŸ’Œ Mailing Lists πŸ’Œ

User feedback is an integral part of the evolution of this and other Bioperl modules, fr fr. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated β€” like, genuinely, they want to hear from you. 🫢

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

πŸ«‚ Support πŸ«‚

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. There are so many experienced and reponsive experts on there who will be able to look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible. Not me begging you to include the code πŸ™ˆ β€” seriously, include the code.

πŸ› Reporting Bugs πŸ›

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

https://github.com/bioperl/bioperl-live/issues

No cap, they actually read these. ✨


πŸ‘‘ AUTHOR - Jason Stajich πŸ‘‘

Email jason@bioperl.org


πŸ“– APPENDIX πŸ“–

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ β€” that underscore is your little heads-up that it's private business, iykyk. 🀫

🌸 new 🌸

Title   : new
Usage   : my $obj = Bio::Search::Result::ResultFactory->new();
Function: Builds a new Bio::Search::Result::ResultFactory object
Returns : Bio::Search::Result::ResultFactory
Args    :

Fresh factory, who dis. Zero args needed, she just spawns. πŸŽ€

⭐ create ⭐

Title   : create
Usage   : $factory->create(%args)
Function: Create a new L<Bio::Search::Result::ResultI> object
Returns : L<Bio::Search::Result::ResultI>
Args    : hash of initialization parameters

This is the whole point of the factory, bestie. Hand her a hash of init params, she hands you back a Bio::Search::Result::ResultI. Ate. πŸ”₯

πŸ’œ type πŸ’œ

Title   : type
Usage   : $factory->type('Bio::Search::Result::GenericResult');
Function: Get/Set the Result creation type
Returns : string
Args    : [optional] string to set

Get/set the Result creation type β€” call it with a string to set it, call it with nothing to just read it back. Returns a string either way. [optional] means you don't have to pass anything, no pressure. πŸ¦‹


And that's the whole page, babe β€” this doc came straight out of perl v5.32.1, dated 2021-08-15, and it lives in the User Contributed Perl Documentation section of your man pages. Go forth and build Results. πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…

πŸ“¦ where this page comes from