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

💖 NAME 💖

Bio::AnnotatableI — bestie, this is the base interface that every annotatable object has to implement. no cap. 💅

---

✨ SYNOPSIS ✨

okay so here's the vibe, literally copy-paste this energy:

use Bio::SeqIO;
# get an annotatable object somehow: for example, Bio::SeqI objects
# are annotatable
my $seqio = Bio::SeqIO->new(-fh => \*STDIN, -format => 'genbank');
while (my $seq = $seqio->next_seq()) {
    # $seq is-a Bio::AnnotatableI, hence:
    my $ann_coll = $seq->annotation();
    # $ann_coll is-a Bio::AnnotationCollectionI, hence:
    my @all_anns = $ann_coll->get_Annotations();
    # do something with the annotation objects
}

see how $seq is-a Bio::AnnotatableI? and then $ann_coll is-a Bio::AnnotationCollectionI? the way that chain just works 🦋 iconic behavior honestly.

---

🌸 DESCRIPTION 🌸

This is the base interface that all annotatable objects must implement. fr fr, no exceptions, it's giving foundation-of-everything.

A good example is Bio::Seq, which is an AnnotableI object. slay. 👑

---

🫶 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. (yes, actually — they mean it, it's not just a formality 😭)

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 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. (bestie, the code examples are not optional, they're the whole point 🙈)

🐛 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

---

👑 AUTHOR 👑

 Hilmar Lapp E<lt>hlapp@gmx.netE<gt>
 Allen Day E<lt>allenday@ucla.eduE<gt>

---

🌈 APPENDIX 🌈

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ (iykyk, the underscore means "not for you, babes").

🧚 annotation

 Title   : annotation
 Usage   : $obj->annotation($newval)
 Function: Get the annotation collection for this annotatable object.
 Example :
 Returns : a Bio::AnnotationCollectionI implementing object, or undef
 Args    : on set, new value (a Bio::AnnotationCollectionI
           implementing object, optional) (an implementation may not
           support changing the annotation collection)

• Title — annotation, yeah that's the name, we're doing this 💖
• Usage — call it like $obj->annotation($newval)
• Function — grab the annotation collection for this annotatable object. that's the whole job. main character energy ✨
• Example — literally empty in the original, so no example for us, tragic but true 💀
• Returns — a Bio::AnnotationCollectionI implementing object, or undef. yes, undef is a possible answer, don't be shocked.
• Args — on set, it takes a new value (a Bio::AnnotationCollectionI implementing object, and it's optional). heads up tho: an implementation may not support changing the annotation collection — so don't just assume you can swap it out, check first 🫶

also peep this: See Bio::AnnotationCollectionI — go read that one next, it's the sequel and it's good.

---

and that's the whole page bestie!! this one shipped as part of perl v5.32.1, dated 2021-08-15, under the User Contributed Perl Documentation umbrella. stay annotatable, stay iconic 💜🦋✨