.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GO::Model::Relationship 3pm"
.TH GO::Model::Relationship 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
.Vb 1
\&  GO::Model::Relationship \- relationship between two terms
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
a relationship between two GO::Model::Terms
.PP
relationships can be thought of as \fBstatements\fR or sentences of the form
.PP
.Vb 1
\&  SUBJECT\-TERM PREDICATE OBJECT\-TERM
.Ve
.PP
for example,
.PP
.Vb 1
\&  "dog" IS_A "animal"
\&
\&  "G\-Protein coupled receptor" IS_A "transmembrane receptor"
.Ve
.PP
Statements have a \fBsubject\fR (i.e. the subject of the
sentence/statement), a predicate/relationship\-type and an \fBobject\fR
(i.e. the object of the sentence/statement)
.PP
Relationships can also be seen as arcs in a directed graph, with the
subject being equivalent to the child, and the object equivalent to
the parent. The arc is labeled with the predicate/relationship\-type.
.PP
A Relationship object currently does not contain an actual pointer to
a GO::Model::Term object. Instead it stores the \s-1ID\s0 of that term. This
is intended to be used in conjunction with the Graph object, or with
the database.
.SS "subject_acc"
.IX Subsection "subject_acc"
.Vb 8
\& 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)
.Ve
.PP
All Relationships can be thought of \*(L"subject-predicate-object\*(R"
statements. The statement is *about* the subject, and states something
about the relationship *to* the object.
.PP
For example, the if we have a Relationship:
.PP
.Vb 6
\&  cell
\&    ^
\&    |
\&    | [part_of]
\&    |
\& cell nucleus
.Ve
.PP
This is a statement about cell nuclei in general, so \*(L"cell nucleus\*(R" 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 \*(L"cell\*(R"
.SS "object_acc"
.IX Subsection "object_acc"
.Vb 9
\& 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
.Ve
.SS "type"
.IX Subsection "type"
.Vb 8
\& Title   : type
\& Usage   : $obj\->type($newval)
\& Usage   : $currval = $obj\->type()
\& Synonyms: 
\& Function: gets or sets the relationship type (a string)
\& Example : 
\& Returns : value of type (string)
\& Args    : on set, new value (string)
.Ve
.PP
Currently any string is allowed; in future the type string may be
constrained to come from a controlled vocabulary of relationship types