.\" 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 "Bio::Chado::Schema::Util 3pm"
.TH Bio::Chado::Schema::Util 3pm "2020-12-04" "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"
Bio::Chado::Schema::Util \- utility functions shared by Bio::Chado::Schema objects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  sub create_organismprops {
\&      my ($self, $props, $opts) = @_;
\&
\&      # process opts
\&      $opts ||= {};
\&      $opts\->{cv_name} = \*(Aqorganism_property\*(Aq
\&          unless defined $opts\->{cv_name};
\&
\&      return Bio::Chado::Schema::Util\->create_props
\&          ( properties => $props,
\&            options    => $opts,
\&            row        => $self,
\&            prop_relation_name => \*(Aqorganismprops\*(Aq,
\&          );
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Helper functions used by several schema classes.
.PP
Important Note:
This package is located in the Schema.pm file as secondary package
and it haven't a file for itself. Nevertheless, the use will be the same.
.SH "PACKAGE METHODS"
.IX Header "PACKAGE METHODS"
.SS "create_properties"
.IX Subsection "create_properties"
.Vb 5
\&  Usage: *::Util\->create_properties( row => $self,
\&                                     properties => { baz => 2, foo => \*(Aqbar\*(Aq },
\&                                     options => { cv_name => autocreate => 0, ...},
\&                                     prop_relation_name => \*(Aqorganismprops\*(Aq,
\&                                   );
\&
\&  Desc : Chado has a number of <thing>prop tables with a similar
\&         structure.  This utility function is used by a number of
\&         modules to create properties in these kinds of tables.
\&
\&  Args : row => the DBIC row object to create properties for,
\&         prop_relation_name => the DBIC relation name for the
\&                               properties table to operate on,
\&                               e.g. \*(Aqfeatureprops\*(Aq,
\&         properties => hashref of { propname => value, ...},
\&         options => options hashref as:
\&             {
\&               autocreate => 0,
\&                  (optional) boolean, if passed, automatically create cv,
\&                  cvterm, and dbxref rows if one cannot be found for the
\&                  given featureprop name.  Default false.
\&
\&               cv_name => cv.name to use for the given featureprops.
\&                          Defaults to \*(Aqfeature_property\*(Aq,
\&
\&               db_name => db.name to use for autocreated dbxrefs,
\&                          default \*(Aqnull\*(Aq,
\&
\&               allow_duplicate_values => default false.
\&                   If true, allow duplicate instances of the same cvterm
\&                   and value in the properties of the feature.  Duplicate
\&                   values will have different ranks.
\&
\&               dbxref_accession_prefix => optional, default
\&                                          \*(Aqautocreated:\*(Aq,
\&               definitions => optional hashref of:
\&                   { cvterm_name => definition,
\&                   }
\&                to load into the cvterm table when autocreating cvterms
\&             }
\&  Ret  : hashref of { propname => new row object in property table }
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Robert Buels, <rmb32@cornell.edu>
.PP
Naama Menda, <naama.menda@gmail.com>