cas.saveRDS: Write a CAS Table to RDS

View source: R/read_write.R

cas.saveRDSR Documentation

Write a CAS Table to RDS

Description

This function downloads an in-memory table from the CAS server and saves it as an RDS file that is accessible to R (the client). This function is a convenience wrapper for the R saveRDS function.

Usage

cas.saveRDS(
  CASTable,
  file = "",
  ascii = FALSE,
  version = NULL,
  compress = TRUE,
  refhook = NULL
)

Arguments

CASTable

The instance of the CASTable to save as as an RDS file.

file

An character string that specifies the filename for the RDS file. If you do not specify the file, then the in-memory table name is used with an .rds suffix. This value is passed to saveRDS.

ascii

An optional logical value. When set to TRUE or NA, then an ASCII representation is written. Otherwise, a binary is written. This value is passed to saveRDS.

version

An optional numeric value. This value is passed to saveRDS.

compress

An optional logical value. When set to one of TRUE, "gzip", "bzip2", or "xz", then compression is used. TRUE performs gzip. This value is passed to saveRDS.

refhook

An optional value that is passed to saveRDS.

See Also

Other functions for saving in-memory data: cas.write.csv(), cas.write.table(), cas.write.xlsx()

Examples

## Not run: 
cas.saveRDS(myCasTable, file="/path/to/data_out.rds")

## End(Not run)

sassoftware/R-swat documentation built on Feb. 26, 2024, 8 a.m.