Bio::Biblio::Ref(3pm)

💖 NAME 💖

Bio::Biblio::Ref — bestie, it's a representation of a bibliographic reference. That's it. That's the whole thing. A lil storage baddie for citations. ✨

---

🌸 VERSION 🌸

version 1.70 — yes queen, she's been through some updates 💅

---

🦋 SYNOPSIS 🦋

okay so here's the vibe, two ways to do the exact same thing:

    $obj = Bio::Biblio::Ref->new(-type  => 'Letter',
                                 -title => 'Onegin to Tatiana');
  #--- OR ---

    $obj = Bio::Biblio::Ref->new();
    $obj->type ('Letter');

like, either you hand it everything at birth 🍼 or you build her up piece by piece. both valid. both slay.

---

🎀 DESCRIPTION 🎀

So. This is a storage object for a general bibliographic reference — aka a citation. It's giving "I hold your metadata and I hold it well."

Wanna see where she sits in the class hierarchy? The whole family tree is right here, no cap:

http://www.ebi.ac.uk/~senger/openbqs/images/bibobjects_perl.gif

🌈 Attributes 🌈

These attributes? They're specific to this class, and — plot twist — they get inherited by all citation types. So every citation type downstream is walking around with these. Iconic behavior, honestly.

• author_list_complete — values: 'Y' (default) or 'N'
• authors — type: array ref of Bio::Biblio::Provider's
• cross_references — type: array ref of Bio::Annotation::DBLink's
• cross_references_list_complete — values: 'Y' (default) or 'N'
• abstract
• abstract_language
• abstract_type
• codes — type: hash ref
• contributors — type: array ref of Bio::Biblio::Provider's
• date
• date_completed
• date_created
• date_revised
• format
• identifier
• keywords
• language
• last_modified_date
• publisher — type: Bio::Biblio::Provider
• repository_subset
• rights
• spatial_location
• subject_headings — type: hash ref
• subject_headings_source
• temporal_period
• title
• toc
• toc_type
• type

---

✨ METHODS ✨

💫 add_cross_reference

• Usage :

    $self->add_cross_reference
          (Bio::Annotation::DBLink->new(-database   => 'EMBL',
                                        -primary_id => 'V00808');

• Function : adding a link to a database entry 🔗
• Returns : new value of 'cross_references'
• Args : an object of type Bio::Annotation::DBLink

💫 add_author

• Usage :

    $self->add_author (Bio::Biblio::Person->new(-lastname => 'Novak');

• Function : adding an author to a list of authors ✍️
• Returns : new value of 'authors' (a full list — the whole squad, not just the new one)
• Args : an object of type Bio::Biblio::Provider

💫 add_contributor

• Usage :

    $self->add_contributor (Bio::Biblio::Person->new(-lastname => 'Novak');

• Function : adding a contributor to a list of contributors 🫶
• Returns : new value of 'contributors' (a full list, again — everybody, all at once)
• Args : an object of type Bio::Biblio::Provider

---

👑 SEE ALSO 👑

• OpenBQS home page

http://www.ebi.ac.uk/~senger/openbqs/

• Comments to the Perl client

http://www.ebi.ac.uk/~senger/openbqs/Client_perl.html

---

💌 FEEDBACK 💌

📬 Mailing lists

User feedback is an integral part of the evolution of this and other Bioperl modules. So like, send your comments and suggestions — preferably to the Bioperl mailing list. 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. There are many experienced and responsive experts who'll be able to look at the problem and quickly address it. If at all possible, please include a thorough description of the problem with code and data examples. The more detail the better, bestie — it's giving "help us help you" 💅

🐛 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://redmine.open-bio.org/projects/bioperl/

---

⚖️ LEGAL ⚖️

🖋️ Authors

Martin Senger <senger@ebi.ac.uk>

Heikki Lehvaslaiho <heikki@bioperl.org>

📜 Copyright and License

This software is Copyright (c) by 2002 European Bioinformatics Institute and released under the license of the same terms as the perl 5 programming language system itself.

---

okay that's the whole page, you ate that 💅 and just so you know exactly what you're holding: this was perl v5.36.0, dated 2023-02-14, and it's the Bio::Biblio::Ref(3pm) page. go forth and cite responsibly, bestie 🦋✨💖