cas.write.xlsx: Write a CAS Table to a Microsoft Excel Workbook

View source: R/read_write.R

cas.write.xlsxR Documentation

Write a CAS Table to a Microsoft Excel Workbook

Description

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

Usage

cas.write.xlsx(
  CASTable,
  file = "",
  sheetName = "Sheet1",
  col.names = TRUE,
  row.names = TRUE,
  append = FALSE,
  showNA = TRUE
)

Arguments

CASTable

The instance of the CASTable to save as as a CSV file.

file

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

sheetName

An optional character string that specifies the sheet name in the workbook. This value is passed to write.xlsx.

col.names

An optional logical value that specifies whether column names are included in the workbook. This value is passed to write.xlsx.

row.names

An optional logical value that specifies whether row names are included in the workbook. This value is passed to write.xlsx.

append

An optional logical value. This value is passed to write.xlsx.

showNA

An optional logical value. This value is passed to write.xlsx.

See Also

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

Examples

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

## End(Not run)

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