NAME

Statistics::R::IO::RData - Supply object methods for RData files

VERSION

This documentation refers to version 0.03 of the module.

SYNOPSIS

use Statistics::R::IO::RData;

my $rdata = Statistics::R::IO::RData->new('.RData');
my %r_workspace = $rdata->read;
while (my ($var_name, $value) = each %r_workspace) {
    print $var_name, $value;
}
$rdata->close;

DESCRIPTION

Statistics::R::IO::RData provides an object-oriented interface to parsing RData files. RData files store a serialization of a collection of named objects, typically a workspace. These files are created in R using the save function and are typically named with the .RData file extension. (Contents of the R workspace can also be saved automatically on exit to the file named .RData, which is by default automatically read in on startup.)

METHODS

CONSTRUCTOR

new $filename

The single-argument constructor can be invoked with a scalar containing the name of the RData file. This file will be immediately opened for reading using IO::File. The method will raise an exception if the file is not readable.

new ATTRIBUTE_HASH_OR_HASH_REF

The constructor's arguments can also be given as a hash or hash reference, specifying values of the object attributes (in this case, 'fh', for which any subclass of IO::Handle can be used).

ACCESSORS

fh

A file handle (stored as a reference to the IO::Handle) to the data being parsed.

METHODS

read

Reads a contents of the filehandle and returns a hash whose keys are the names of objects stored in the file with corresponding values as Statistics::R::REXP instances.

close

Closes the object's filehandle. This method is automatically invoked when the object is destroyed.

BUGS AND LIMITATIONS

There are no known bugs in this module. Please see Statistics::R::IO for bug reporting.

SUPPORT

See Statistics::R::IO for support and contact information.

AUTHOR

Davor Cubranic, <cubranic at stat.ubc.ca>

LICENSE AND COPYRIGHT

Copyright 2014 University of British Columbia.

See Statistics::R::IO for the license.