SWISS::GeneGroup(3pm)

📦
version 1.80 · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

SWISS::GeneGroup.pm — the Perl module that's basically a lil friend group for gene names 💖 (living in the SWISS::GeneGroup(3pm) era of the User Contributed Perl Documentation, iykyk)

🌸 DESCRIPTION 🌸

okay so bestie, listen. A SWISS::GeneGroup object holds all the synonyms for one given gene name. That's it, that's the job. It's giving "I collect every name this gene goes by" energy 👑

Wanna know what the gene name format actually looks like? Go read SWISS::GNs, it spills all the tea on that.

🧬 INHERITS FROM 🧬

  • SWISS::BaseClass.pm

and also — plot twist — it implements many methods from SWISS::ListBase.pm too 🫶

🎀 ATTRIBUTES 🎀

  • Names — every element in this list is a SWISS::GN object, describing a primary name or a synonym. Lowkey it's just the concatenation of the Name and Synonyms lists, no cap.
  • OLN — every element in this list is a SWISS::GN object, describing an OrderedLocusName.
  • ORFNames — every element in this list is a SWISS::GN object, describing an ORFName.

💅 METHODS 💅

⭐ Standard methods ⭐

  • new
  • fromText
  • toText

🦋 Specific methods 🦋

  • Name — returns the Name, aka the primary name. The main character, fr fr.
  • Synonyms — returns the Synonyms. The supporting cast 💜
  • elements — concatenates all the elements from Names, OLN and ORFNames into a single array. One big happy family 🌈

🌸 List manipulation methods 🌸

so here's the lore: since GeneGroup was a previous implementation of SWISS::ListBase, all the list manipulation methods down below are provided just to facilitate compatibility. They're here for the vibes (and the backwards compat) 🫶

  • size
  • isEmpty
  • elements
  • filter
  • get (deprecated)
  • head (deprecated)
  • tail (deprecated)
  • item (deprecated)
  • push (deprecated)
  • pop (deprecated)
  • shift (deprecated)
  • splice (deprecated)
  • unshift (deprecated)
  • set (deprecated)
  • add (deprecated)
⚠️ heads up bestie: everything marked (deprecated) is deprecated. Still there, still works (probably), but like… it's giving legacy. Use with awareness, not with your whole heart 💀

and that's the whole page, periodt 💖 this lil rewrite rides on perl v5.32.1, dated 2021-08-15 — shoutout to that vintage timestamp, she's iconic, no cap 🎀✨

📦 where this page comes from