wb_save {openxlsx2} | R Documentation |
Save a workbook to file
Description
Save a workbook to file
Usage
wb_save(wb, file = NULL, overwrite = TRUE, path = NULL, flush = FALSE)
Arguments
wb |
A |
file |
A path to save the workbook to |
overwrite |
If |
path |
Deprecated argument. Please use |
flush |
Experimental, streams the worksheet file to disk |
Details
When saving a wbWorkbook
to a file, memory usage may spike
depending on the worksheet size. This happens because the entire XML
structure is created in memory before writing to disk. The memory
required depends on worksheet size, as XML files consist of character
data and include additional overhead for validity checks.
The flush
argument streams worksheet XML data directly to disk,
avoiding the need to build the full XML tree in memory. This reduces
memory usage but skips some XML validity checks. It also bypasses
the pugixml
functions that openxlsx2
uses, omitting certain
preliminary sanity checks before writing. As the name suggests,
the output is simply flushed to disk.
Value
the wbWorkbook
object, invisibly
See Also
Other workbook wrappers:
base_font-wb
,
col_widths-wb
,
creators-wb
,
grouping-wb
,
row_heights-wb
,
wb_add_chartsheet()
,
wb_add_data()
,
wb_add_data_table()
,
wb_add_formula()
,
wb_add_hyperlink()
,
wb_add_pivot_table()
,
wb_add_slicer()
,
wb_add_worksheet()
,
wb_base_colors
,
wb_clone_worksheet()
,
wb_copy_cells()
,
wb_freeze_pane()
,
wb_merge_cells()
,
wb_set_last_modified_by()
,
wb_workbook()
Examples
## Create a new workbook and add a worksheet
wb <- wb_workbook("Creator of workbook")
wb$add_worksheet(sheet = "My first worksheet")
## Save workbook to working directory
wb_save(wb, file = temp_xlsx(), overwrite = TRUE)