.\" 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::IO::RDS 3pm"
.TH Statistics::R::IO::RDS 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::IO::RDS \- Supply object methods for RDS files
.SH "VERSION"
.IX Header "VERSION"
version 1.0002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Statistics::R::IO::RDS;
\&    
\&    my $rds = Statistics::R::IO::RDS\->new(\*(Aqfile.rds\*(Aq);
\&    my $var = $rds\->read;
\&    print $var\->to_pl;
\&    $rds\->close;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Statistics::R::IO::RDS\*(C'\fR provides an object-oriented interface to
parsing \s-1RDS\s0 files. \s-1RDS\s0 files store a serialization of a single R
object (and, if the object contains references to other objects, such
as environments, all the referenced objects as well). These files are
created in R using the \f(CW\*(C`readRDS\*(C'\fR function and are typically named
with the \f(CW\*(C`.rds\*(C'\fR file extension.
.SH "METHODS"
.IX Header "METHODS"
\&\f(CW\*(C`Statistics::R::IO::RDS\*(C'\fR inherits from Statistics::R::IO::Base and
provides an implementation for the \*(L"read\*(R" method that parses \s-1RDS\s0
files.
.IP "read" 4
.IX Item "read"
Reads the contents of the filehandle and returns a
Statistics::R::REXP.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Instances of this class are intended to be immutable. Please do not
try to change their value or attributes.
.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