Bio::I...ctionI(3pm)

💖 Bio::IdCollectionI 💖

okay so bestie, gather round, because we're talking about Bio::IdCollectionI — the interface for objects with multiple identifiers 🌈. This little icon is part of the User Contributed Perl Documentation collection, and honestly? she's giving "backstage pass to the whole identifier party" energy. Periodt. 💅

---

✨ NAME ✨

Bio::IdCollectionI — an interface for objects with multiple identifiers, each one repping a different authority. no cap. 👑

---

🎀 SYNOPSIS 🎀

first things first, bestie — vibe check whether your object actually is one of these identifiable collection girlies:

# to test this is an identifiable collection object

$obj->isa("Bio::IdCollectionI") ||
  $obj->throw("$obj does not implement the Bio::IdCollectionI interface");

then the accessors, aka the fun part 🦋:

# accessors
@authorities = $obj->id_authorities();
@ids         = $obj->ids();
$id          = $obj->ids($authority);

---

🌸 DESCRIPTION 🌸

okay so real talk: this interface describes the methods you're expected to have on objects that carry multiple identifiers, and each of those identifiers is controlled by a different authority. it's giving "everyone has their own manager" and honestly we respect it. 💜

---

💌 FEEDBACK 💌

Mailing Lists 📬

user feedback is an integral part of the evolution of this and other Bioperl modules — like, genuinely, it's the main character of the whole glow-up. send your comments and suggestions preferably to one of the Bioperl mailing lists. your participation is much appreciated, fr fr 🫶

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. many experienced and responsive 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. the more detail the better, bestie — it's giving "help me help you" 😭✨

Reporting Bugs 🐛

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

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

---

👑 AUTHOR - Lincoln Stein 👑

email lstein@cshl.org — icon behavior, we stan. 💖

---

🧚 Implementation Specific Functions 🧚

these functions are the ones that a specific implementation must define. like, no skipping, this is the homework. 📝

id_authorities

Title   : id_authorities
Usage   : @array    = $obj->id_authorities()
Function: Return the authorities which have names for this object.
          The authorities can then be used to select ids.

Returns : An array
Status  : Virtual

ids

Title   : ids
Usage   : @ids    = $obj->ids([$authority1,$authority2...])
Function: return a list of Bio::IdentifiableI objects, optionally
          filtered by the list of authorities.

Returns : A list of Bio::IdentifiableI objects.
Status  : Virtual

🫶 heads up bestie: both of these are marked Virtual — meaning the interface is telling you what to implement, not how. that part is on you, and you're gonna slay it.

---

that's the whole page, babes 💕 this gem ships with perl v5.32.1 and the doc itself is dated 2021-08-15 — iconic, timeless, still ate. mwah 💋 ✨ 🦋