SWISS::Ref(3pm)

💖 SWISS::Ref 💖

okay bestie, welcome to SWISS::Ref — it's a Perl module, it lives in the User Contributed Perl Documentation corner of the manual-verse, and it is so much more chill than it looks. This is the SWISS::Ref.pm page, and it's basically about one (1) single reference. Periodt.

---

✨ Name ✨

SWISS::Ref.pm — that's the whole name, that's it, that's the girl 💅

---

🌸 Description 🌸

So. SWISS::Ref represents a single reference of a SWISS-PROT + TREMBL entry, exactly as specified in the user manual over at http://www.expasy.org/sprot/userman.html .

Like, one reference. One. Not a whole bibliography, not the vibes of a bibliography — one single reference object. She's focused. She's main character energy. 🎀

---

🦋 Inherits from 🦋

• SWISS::BaseClass.pm

yep, she gets her whole thing from SWISS::BaseClass.pm, as one does 👑

---

💜 Attributes 💜

okay this is the good part, here's everything she's holding:

• "RN" — the reference number. that's it. the number. iconic.
• "RP" — the RP line(s), but unwrapped as a string. so like, all chill and flat instead of all folded up.
• "RC" — zero or more RC lines. yes, zero is allowed, she's flexible.

Data structure: {Token}[qualifier1, qualifierN].

So it's a hash of arrays. the hash keys are the RC tokens, and the array elements are the qualifiers for that token. iykyk 🧚

• "RX" — references to bibliographic databases. the whole point, lowkey.

Data structure: {Database}[identifier1, identifierN].

Another hash of arrays. hash keys = the names of the bibliographic databases, array elements = the identifiers of the reference for that database. so if you ever wondered "which database, and which ID in that database," boom, there it is ✨

• "RG" — the RG line(s), unwrapped as a string. same deal as RP, just RG.
• "RA" — the list of Authors.

An object of type SWISS::ListBase. not a plain array, not a string, an object. she has range.

• "RT" — the publication title, unwrapped as a string. yes bestie, the title.
• "RL" — the RL line.

Data structure: String. just a string. simple. clean. slay.

---

🔥 Methods 🔥

⭐ Standard methods ⭐

• new
• fromText
• toText

that's the trio, the holy trinity, the classics 🫶

💅 Writing methods 💅

• add_MedlineID — add an RX line 'MEDLINE; nnnnnnnn.' to the reference. so like, you're giving this ref a MEDLINE moment.
• add_Author — add an author to the RA line of the reference. one more name on the roster, no cap.
• rc_sort — sort elements of the RC line alphabetically. she's putting her RC line in order because she's organized like that 💖

---

💀 POD ERRORS 💀

NOT me having to tell you this but: hey! the above document had some coding errors, which are explained below. it's giving messy but we move.

• Around line 542:

=over without closing =back

fr fr, that's the error. an =over with no closing =back. the open parenthesis of POD directives. the unfinished sentence of documentation. we don't gatekeep, we just report it 🙈

---

and that's the whole page, bestie. every attribute, every data structure, every method, every POD error — all accounted for. no details lost, only vibes gained. 🎀

mwah 💋

signing off: this was SWISS::Ref(3pm), generated by perl v5.32.1 on 2021-08-15. she's a little vintage, she's a little iconic, and she ate. periodt. 👑