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

💖 Bio::Cluster::ClusterFactory 💖

okay bestie, gather round, because this is the Bio::Cluster::ClusterFactory page from the Perl docs (you know, that Bio::C...actory(3pm) header thing) and it's literally so much cuter than it looks.

NAME

Bio::Cluster::ClusterFactory — the lil factory that instantiates a brand new Bio::ClusterI (or any derived class) for you. no cap, that's the whole job.

---

✨ SYNOPSIS ✨

use Bio::Cluster::ClusterFactory;
# if you don't provide a default type, the factory will try
# some guesswork based on display_id and namespace
my $factory = Bio::Cluster::ClusterFactory->new(-type => 'Bio::Cluster::UniGene');
my $clu = $factory->create_object(-description => 'NAT',
                                  -display_id  => 'Hs.2');

like… look at her. so tidy. 🎀

---

🌸 DESCRIPTION 🌸

This object builds Bio::ClusterI objects generically. that's it, that's the vibe. it's giving "one factory to rule them all" and honestly? iconic.

---

🫶 FEEDBACK 🫶

💌 Mailing Lists

bestie, user feedback is an integral part of the evolution of this module and every other Bioperl module — like, it's the whole glow-up pipeline. send your comments and suggestions preferably to the Bioperl mailing list. your participation is so much appreciated. 💅

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

🧚 Support

okay real talk: please send usage questions and support issues to the mailing list:

bioperl-l@bioperl.org

…rather than DMing the module maintainer directly. not because they're mean (they're not!), but because there are many experienced and responsive experts there who can look at your problem and fix it fast. and please include a thorough description of the problem with code and data examples if at all possible — the more deets, the faster the slay. 🙈

🐛 Reporting Bugs

report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution together, as a little community. bug reports can be submitted via the web:

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

---

👑 AUTHOR - Hilmar Lapp

Email hlapp at gmx.net — go give them their flowers, fr fr. 💐

---

🦋 APPENDIX 🦋

the rest of this documentation details each of the object methods, one by one. internal methods are usually preceded with a _ (you know, the secret ones). 🔥

🌈 new

• Title: new
• Usage: my $obj = Bio::Cluster::ClusterFactory->new();
• Function: builds a new Bio::Cluster::ClusterFactory object
• Returns: Bio::Cluster::ClusterFactory
• Args: -type => string, the name of a ClusterI derived class.

⚠️ if -type is not provided, the factory will have to guess from ID and namespace — which may or may not be successful. so like, no promises, bestie. 💀

🌈 create_object

• Title: create_object
• Usage: my $seq = $factory->create_object(<named parameters>);
• Function: instantiates a new Bio::ClusterI (or one of its child classes).

This object lets us genericize the instantiation of cluster objects. ✨

• Returns: an L<Bio::ClusterI> compliant object.

The return type is configurable using new(-type =>"...").

• Args: initialization parameters specific to the type of cluster object we want. Typically:
  • -display_id => $name
  • -description => description of the cluster
  • -members => arrayref, members of the cluster

🌈 _guess_type

• Title: _guess_type
• Usage:
• Function: guesses the right type of L<Bio::ClusterI> 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

---

and that's the whole page, periodt. 💜 this was pulled from perl v5.34.0, dated 2022-03-27 — vintage but still serving. stay hydrated, read your docs, and go build some clusters. 🍓✨