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

💖 Bio::Annotation::AnnotationFactory — the manual, but make it make sense 💖

okay bestie, gather round, because this is the Perl page for Bio::Annotation::AnnotationFactory, straight out of the User Contributed Perl Documentation collection. it's the lil factory that spins up Bio::AnnotationI objects (or any of its glow-up children) without you having to hand-build each one. no cap. 🧚✨

---

✨ NAME ✨

Bio::Annotation::AnnotationFactory — Instantiates a new Bio::AnnotationI (or derived class) through a factory

it's giving object factory, and honestly? iconic behaviour. 👑

---

🌸 SYNOPSIS 🌸

use Bio::Annotation::AnnotationFactory;
#
my $factory = Bio::Annotation::AnnotationFactory->new(
                -type => 'Bio::Annotation::SimpleValue');
my $ann = $factory->create_object(-value => 'peroxisome',
                                  -tagname => 'cellular component');

look at her go 🦋 — make a factory, tell it what type of annotation you want, then ask it for objects. that's the whole vibe.

---

💅 DESCRIPTION 💅

This object will build Bio::AnnotationI objects generically.

fr fr, that's the entire deal. one factory, any annotation class, zero drama. 🔥

---

📬 FEEDBACK 📬

💌 Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

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

like, they actually want to hear from you. your comments are the main character here. 💖

🫶 Support

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

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able 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.

ngl this is just good group-chat etiquette: ask the whole chat, not one person's DMs, and drop the receipts (code + data) so someone can actually help. 📎✨

🐛 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

bug reports are love letters to future you. submit them at the link above. 💀➡️💖

---

👑 AUTHOR - Hilmar Lapp 👑

Email hlapp at gmx.net

---

🌈 CONTRIBUTORS 🌈

This is mostly copy-and-paste with subsequent adaptation from Bio::Seq::SeqFactory by Jason Stajich. Most credits should in fact go to him.

periodt. give that man his flowers. 🌸🏆

---

📖 APPENDIX 📖

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

heads up bestie: anything starting with an underscore is internal — iykyk, probably not your business, but we're listing it anyway because completeness is the vibe. 💁

🎀 new

Title   : new
Usage   : my $obj = Bio::Annotation::AnnotationFactory->new();
Function: Builds a new Bio::Annotation::AnnotationFactory object
Returns : Bio::Annotation::AnnotationFactory
Args    : -type => string, name of a L<Bio::AnnotationI> derived class.

If type is not set the module guesses it based on arguments passed to method create_object.

so like, you can tell it the type up front, or you can leave it blank and let it read the room. both slay. ✨

🧵 create_object

Title   : create_object
Usage   : my $seq = $factory->create_object(<named parameters>);
Function: Instantiates new Bio::AnnotationI (or one of its child classes)

          This object allows us to genericize the instantiation of
          cluster objects.

Returns : L<Bio::AnnotationI> compliant object
          The return type is configurable using new(-type =>"...").
Args    : initialization parameters specific to the type of annotation
          object we want.

this is the moment. the create_object call is where the actual annotation object gets born. 🦋 the return type is fully configurable via new(-type => "..."), and the args you pass are specific to whichever annotation type you're building. lowkey elegant.

🌟 type

Title   : type
Usage   : $obj->type($newval)
Function: Get/set the type of L<Bio::AnnotationI> object to be created.

          This may be changed at any time during the lifetime of this
          factory.

Returns : value of type
Args    : newvalue (optional)

get it, set it, change it whenever you want — this factory is flexible and we respect that. 💅

🔮 _guess_type

Title   : _guess_type
Usage   :
Function: Guesses the right type of L<Bio::AnnotationI> implementation
          based on initialization parameters for the prospective
          object.
Example :
Returns : the type (a string, the module name)
Args    : initialization parameters to be passed to the prospective
          cluster object

she guesses. she's right. she returns the type as a string, i.e. the module name. psychic queen behaviour, no notes. 🧚♀️

---

💜 SEE ALSO 💜

hmm, there's no SEE ALSO section in this one, bestie — but you already got a shoutout to Bio::Seq::SeqFactory up in CONTRIBUTORS, so go peep that if you're curious. 🫶

---

and that's the whole page, gorgeous. this one shipped as part of perl v5.32.1, dated 2021-08-15 — so yeah, slightly vintage, but still absolutely eating. 💖✨🎀