pickle: Serialize object maintaining internal object references

View source: R/pickle.R

pickleR Documentation

Serialize object maintaining internal object references

Description

Recurses through the object hierarchy storing unique elements and the information necessary to reconstitute the object.

Usage

pickle(object, connection = NULL, compress = TRUE, ...)

Arguments

object

The object to 'pickle'.

connection

an open connection, a string indicating the desired filename or NULL. If NULL returns a raw vector.

compress

if connection is a string, and compress is TRUE, opens a gzfile to store the pickled object data to. If compress is FALSE no compression is applied. Compress can also be one of bzip, xz, gzip to indicate the type of compression to apply.

...

arguments passed to or from other methods.

Value

NULL unless connection = NULL, when the result is returned in a raw vector.


d-sharpe/pickleR documentation built on July 8, 2022, 7:31 p.m.