save_xlsx: Save a data frame to an excel spreadsheet

In towananalytics/tatools: Towan Analytics Tools

Description

Wrapper for openxlsx to easily output a data frame as an excel spreadsheet.

Usage

save_xlsx(
  data = NULL,
  file.name = NA,
  file.location = NA,
  apply.header = FALSE,
  header.title = NA,
  header.font.style = "Arial",
  header.font.size = 12,
  header.font.colour = "008C98",
  apply.style = FALSE,
  borders = NA,
  start.rows = NA,
  start.cols = NA,
  body.wrap.text = FALSE,
  body.valign = "center",
  body.halign = "left",
  withFilter = NA
)

Arguments

data	vector of strings containing the name(s) of data frame objects
file.name	the file name of the excel file, excluding the path and extension details
file.location	the file path to save the file, by default, this is the project home folder
apply.header	default is FALSE. If enabled, and without header.title arguments, the data frame object names are as the header titles
header.title	a string vector to override the default data frame object names in the header output. The length of this vector must equal the number of data frames
header.font.style	string vector options are limited to standard font styles
header.font.size	integer value
header.font.colour	hex colour format without the hash (#) prefix
apply.style	logical argument to include a standard styling to the output. Styling includes header and body styles
borders	string vector that applies a border style to the output data. Default is "rows". Options are "none", "surrounding", "rows", "columns", "all". Vector length should equal the number of data frame objects
start.rows	Vector of integers specifying the row index to insert the data. Vector length should equal the number of data frame objects
start.cols	Vector of integers specifying the column index to insert the data. Vector length should equal the number of data frame objects
body.wrap.text	wrap body text in table outputs. Logical argument with a default value of FALSE
body.valign	vertical alignment of body text. Default is "center", options are "center", "top", "bottom". Can be a vector of length 1 or separate arguments for each data frame
body.halign	horizontal alignment of body text. Default is "left", options are "left", "center", "right". Can be a vector of length 1 or separate arguments for each data frame
withFilter	vector of logical values to include filters at the column names in the spreadsheet. Default is FALSE. Vector length should equal the number of data frame objects.

Value

Saved data frames as .xlsx format to the required folder.

Examples

a <- data.frame(mtcars)
b <- data.frame(letters)
sleep <- data.frame(msleep)

save_xlsx(data = c("a", "b"))
save_xlsx(data = c("a", "b"), apply.style = TRUE)
save_xlsx(data = c("a", "b"), apply.style = TRUE, start.rows = c(1, 2))
save_xlsx(data = c("a", "b"), apply.style = TRUE, start.rows = c(1, 2), start.cols = c(3, 4))
save_xlsx(data = c("a", "b", "sleep"), apply.style = TRUE, start.rows = c(1, 2, 2), start.cols = c(3, 4, 2))
save_xlsx(data = c("a", "b", "sleep"), apply.style = TRUE, file.name = "new file")
save_xlsx(data = c("a", "b", "sleep"), apply.header = TRUE)
save_xlsx(data = c("a", "b", "sleep"), apply.header = TRUE, file.location = getwd())
save_xlsx(data = c("a", "b", "sleep"), header.title = c("sheet1 header", "sheet2 header", "sheet3 header"))
save_xlsx(data = c("a", "b"), apply.style = TRUE, body.halign = "center")
save_xlsx(data = c("a", "b"), apply.style = TRUE, body.halign = c("center", "right"))

towananalytics/tatools documentation built on Jan. 24, 2022, 7:31 p.m.