.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Statistics::R::REXP 3pm"
.TH Statistics::R::REXP 3pm "2022-02-10" "perl v5.34.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"
Statistics::R::REXP \- base class for R objects ("SEXP"s)
.SH "VERSION"
.IX Header "VERSION"
version 1.0002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Statistics::R::REXP;
\&    
\&    # we usually get REXPs from an RDS file:
\&    my $rexp = Statistics::R::IO::readRDS(\*(Aqfile.rds\*(Aq);
\&    
\&    # REXPs are stringifiable
\&    say $rexp;
\&    
\&    # REXPs can be converted to the closest native Perl data type
\&    print $rexp\->to_pl;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An object of this class represents a native R object. This class
cannot be directly instantiated (it will die if you call \f(CW\*(C`new\*(C'\fR on
it), because it is intended as a base abstract class with concrete
subclasses to represent specific object types.
.PP
An R object has a value and an optional set of named attributes, which
themselves are R objects. Because the meaning of 'value' depends on
the actual object type (for example, a vector vs. a \f(CW\*(C`NULL\*(C'\fR, in R
terminology), \f(CW\*(C`REXP\*(C'\fR does not provide a generic value accessor
method, although individual subclasses will typically have one.
.SH "METHODS"
.IX Header "METHODS"
.IP "attributes" 4
.IX Item "attributes"
Returns a hash reference to the object's attributes.
.IP "sexptype" 4
.IX Item "sexptype"
Returns the \fIname\fR of the corresponding R \s-1SEXP\s0 type, as listed in
\&\s-1SEXPTYPE\s0 <http://cran.r-project.org/doc/manuals/r-release/R-ints.html#SEXPTYPEs>.
.IP "to_pl" 4
.IX Item "to_pl"
Returns \fIPerl\fR representation of the object's value. This is an
abstract method; see concrete subclasses for the value returned by
specific object types, as well as the way to access the \fIR\fR (\-ish)
value of the object, if such makes sense.
.IP "is_null" 4
.IX Item "is_null"
Returns \s-1TRUE\s0 if the object is an R \f(CW\*(C`NULL\*(C'\fR object. In \f(CW\*(C`REXP\*(C'\fR's
class hierarchy, this is the case only for \f(CW\*(C`Statistics::REXP::Null\*(C'\fR.
.IP "is_vector" 4
.IX Item "is_vector"
Returns \s-1TRUE\s0 if the object is an R vector object. In \f(CW\*(C`REXP\*(C'\fR's class
hierarchy, this is the case only for \f(CW\*(C`Statistics::REXP::Vector\*(C'\fR and
its descendants.
.IP "inherits \s-1CLASS_NAME\s0" 4
.IX Item "inherits CLASS_NAME"
Returns \s-1TRUE\s0 if the object is an instance of R S3\-style class
\&\f(CW\*(C`CLASS_NAME\*(C'\fR, in the same fashion as the R function \f(CW\*(C`base::inherits <http://stat.ethz.ch/R-manual/R-patched/library/base/html/class.html>\*(C'\fR.
.SH "OVERLOADS"
.IX Header "OVERLOADS"
\&\f(CW\*(C`REXP\*(C'\fR overloads the stringification, \f(CW\*(C`eq\*(C'\fR and \f(CW\*(C`ne\*(C'\fR methods;
subclasses further specialize for their types if necesssary.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Classes in the \f(CW\*(C`REXP\*(C'\fR hierarchy are intended to be immutable. Please
do not try to change their value or attributes.
.PP
More \f(CW\*(C`is_*\*(C'\fR accessors should be added.
.PP
There are no known bugs in this module. Please see
Statistics::R::IO for bug reporting.
.SH "SUPPORT"
.IX Header "SUPPORT"
See Statistics::R::IO for support and contact information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Davor Cubranic <cubranic@stat.ubc.ca>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2017 by University of British Columbia.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve