GO::Mo...ionship(3pm)

๐Ÿ“ฆ
version 0.15 ยท 2 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

๐Ÿ’– GO::Model::Relationship ๐Ÿ’–

okay so bestie, welcome to the manpage for GO::Model::Relationship, which lives in the User Contributed Perl Documentation section (that's the (3pm) part, iykyk). it's a whole module about the relationship between two terms. that's the vibe. that's the assignment. periodt.


โœจ NAME โœจ

GO::Model::Relationship โ€” relationship between two terms ๐Ÿฆ‹


โœจ SYNOPSIS โœจ

okay soโ€ฆ there's literally nothing here. the SYNOPSIS is empty. it's giving "I have nothing to say" energy and honestly? relatable. moving on ๐Ÿ’…


โœจ DESCRIPTION โœจ

so a Relationship is, like, a relationship between two GO::Model::Terms. two terms. vibing. connected. ๐ŸŒธ

think of relationships as statements or sentences that look like this:

  SUBJECT-TERM PREDICATE OBJECT-TERM

for example:

  "dog" IS_A "animal"

  "G-Protein coupled receptor" IS_A "transmembrane receptor"

every statement has three parts, bestie:

  • a subject โ€” the subject of the sentence/statement
  • a predicate / relationship-type โ€” the thing linking them
  • an object โ€” the object of the sentence/statement

Relationships can also be seen as arcs in a directed graph ๐Ÿ“ˆ, where the subject is equivalent to the child, and the object is equivalent to the parent. the arc gets labeled with the predicate/relationship-type. iconic behaviour honestly.

๐Ÿšจ important tea: a Relationship object currently does not contain an actual pointer to a GO::Model::Term object. instead it stores the ID of that term. this is intended to be used in conjunction with the Graph object, or with the database. so don't go looking for the Term in here, she's not here ๐Ÿ’€

๐ŸŽ€ subject_acc ๐ŸŽ€

  • Title: subject_acc
  • Usage: $obj->subject_acc($newid)
  • Usage: $currid = $obj->subject_acc()
  • Synonyms: subj_acc, acc2, child_acc
  • Function: gets or sets the identifier for the child/subject term
  • Example:
  • Returns: value of subject_acc (string)
  • Args: on set, new value (string)

(yeah the Example line is empty in the original too, not me being lazy, I promise ๐Ÿ™ˆ)

so all Relationships are basically "subject-predicate-object" statements. the statement is about the subject, and it states something about the relationship to the object. queen of grammar fr fr ๐Ÿ‘‘

for example, if we have a Relationship:

         cell
           ^
           |
           | [part_of]
           |
        cell nucleus

this is a statement about cell nuclei in general, so "cell nucleus" is the subject (sometimes called the child node). the Relationship tells us that all cell nuclei are part_of some cell, so the object of the relationship (sometimes called the parent node) is "cell". see how it all connects?? the way that science ate that up ๐Ÿ’…


๐ŸŽ€ object_acc ๐ŸŽ€

  • Title: object_acc
  • Usage: $obj->object_acc($newid)
  • Usage: $currid = $obj->object_acc()
  • Synonyms: obj_acc, acc1, parent_acc
  • Function: gets or sets the identifier for the parent/object term
  • Example:
  • Returns: value of object_acc (string)
  • Args: on set, new value (string)
  • See Also: subj_acc

๐ŸŽ€ type ๐ŸŽ€

  • Title: type
  • Usage: $obj->type($newval)
  • Usage: $currval = $obj->type()
  • Synonyms: (none, she's unbothered)
  • Function: gets or sets the relationship type (a string)
  • Example:
  • Returns: value of type (string)
  • Args: on set, new value (string)
๐Ÿ”ฎ right now, literally any string is allowed. but in future the type string may be constrained to come from a controlled vocabulary of relationship types. so enjoy the freedom while it lasts, bestie ๐Ÿ˜ญ

and that's the whole page!! ๐Ÿ’œ slay โœจ

this was brought to you by perl v5.36.0, dated 2023-12-18 โ€” read the docs, hydrate, and go be the main character of your own directed graph ๐Ÿฆ‹๐Ÿ’–๐ŸŽ€

๐Ÿ“ฆ where this page comes from