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

💖 Bio::Search::Hit::HitFactory — the manual, but make it make sense ✨

okay bestie, so this page lives in your User Contributed Perl Documentation, and the module is literally called Bio::Search::Hit::HitFactory(3pm). Say that five times fast, I dare you. 🫶

🌸 NAME 🌸

Bio::Search::Hit::HitFactory — it's a factory that makes Bio::Search::Hit::HitI objects. That's the whole job. She's a builder, she's booked, she's building. 💅

---

✨ SYNOPSIS ✨

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

look at her. three lines. iconic. no notes. 💜

---

🦋 DESCRIPTION 🦋

so the whole point here is hiding the object creation process, right? like, we don't want the SearchIO parser to be out here hardcoding which class it instantiates. that's not the vibe. instead we keep it indirect so we can dynamically change the objects that are created depending on which format report we're parsing. flexible. adaptable. main character energy, honestly. 👑

and fr fr, this particular object is the one in charge of creating new Hits. that's it, that's her purpose. 🎀

---

💌 FEEDBACK 💌

🧚 Mailing Lists

user feedback is, and I quote the spirit of it, an integral part of how this module and all the other Bioperl modules evolve. so send your comments and suggestions to the Bioperl mailing list, bestie. your participation is much appreciated, no cap. 🫶

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

🌈 Support

okay so if you have a usage question or a support issue, please direct it to the mailing list:

bioperl-l@bioperl.org

and not straight to the module maintainer, okay? not the move. there are tons of experienced and responsive experts on the list who can look at your problem and address it quickly. also please include a thorough description of the problem, with code and data examples if at all possible. give them the whole picture, they deserve it. 🙈

💀 Reporting Bugs

found a bug? report it to the Bioperl bug tracking system so they can keep track of it and its resolution. bug reports can be submitted via the web here:

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

---

👑 AUTHOR — Jason Stajich 👑

email: jason@bioperl.org

---

📖 APPENDIX 📖

the rest of this documentation details each of the object methods, one by one, no skipping. also heads up: internal methods are usually preceded with a _. iykyk. ⭐

🔥 new

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

she builds a brand new Bio::Search::Hit::HitFactory object. no args. just vibes. ✨

🔥 create

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

this is the one doing the actual creating — a new Bio::Search::Hit::HitI object. you hand her a hash of initialization parameters and she returns you a Bio::Search::Hit::HitI. ate. 💅

🔥 type

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

get/set the Hit creation type. returns a string, and the arg is an optional string to set. so like, you can ask her what type she is, or you can tell her what type to be. both are valid. both slay. 🌸

---

real talk though: this module is perl v5.32.1 flavored, dated 2021-08-15. shoutout to the User Contributed Perl Documentation crew for hosting the whole thing. mwah. 💖

stay hydrated, read your manpages, and go make some Hits. periodt. 🦋✨