xlsxtable: Table Template

In IntegralEnvision/integral: Integral Consulting Public Package

Table Template

Description

Apply Integral table style to table for report-ready output

Usage

xlsxtable(
  sheet,
  d,
  title,
  author,
  fpath = NULL,
  wb = NULL,
  style = "L",
  leftjust = 1,
  startcol = 1,
  startrow = 2
)

Arguments

sheet	The sheet(s) added to the workbook
d	The data frame the table is created from
title	The title of the table
author	Author name
fpath	Optional file path to write the table to
wb	Optional workbook option
style	Orientation and page size of the table
leftjust	Number of columns to be left justified
startcol	Optional start column for table
startrow	Optional start row for table

Value

A formatted data table

Examples

int_vec <- c('1', '2', '3')
char_vec <- c("a", "b", "c")
bool_vec <- c(TRUE, TRUE, FALSE)
d <- data.frame(
  int_vec, char_vec,
  bool_vec
)
# Example using a file path
# Note: temp file used to pass build check. Use a non temp file path in reality.
fpath <- tempfile(fileext = ".xlsx")
sheet <- "Sheet1"
title <- "Example Table"
author <- "Eben Pendleton"
outpath <- xlsxtable(sheet, d, title, author, fpath = fpath)

# Example using a workbook object
fpath <- tempfile(fileext = ".xlsx")
sheet <- "Sheet2"
title <- "Example Table"
author <- "Eben Pendleton"
# create workbook
wb <- openxlsx::createWorkbook()
# This returns the Excel workbook object if successful.
wb <- xlsxtable(sheet, d, title, author, wb = wb)
# Save the workbook
openxlsx::saveWorkbook(wb, file = fpath, overwrite = TRUE)

IntegralEnvision/integral documentation built on Nov. 4, 2024, 2 p.m.