add_supertbl_toc: Add the supertbl table of contents sheet

View source: R/write.R

add_supertbl_tocR Documentation

Add the supertbl table of contents sheet

Description

Internal helper function. Adds appropriate elements to wb object. Returns a dataframe.

Usage

add_supertbl_toc(
  wb,
  supertbl,
  include_metadata_sheet,
  add_labelled_column_headers,
  table_style,
  column_width,
  na_replace
)

Arguments

wb

An openxlsx2 workbook object

supertbl

a supertibble generated using read_redcap()

include_metadata_sheet

Include a sheet capturing the combined output of the supertibble redcap_metadata.

add_labelled_column_headers

Whether or not to include labelled outputs.

table_style

Any excel table style name or "none" (see "formatting" in openxlsx2::wb_add_data_table()). Default "tableStyleLight8".

column_width

Width to set columns across the workbook. Default "auto", otherwise a numeric value. Standard Excel is 8.43.

na_replace

The value used to replace NA values in supertbl. The default is "".

Value

A dataframe


REDCapTidieR documentation built on April 3, 2025, 10:50 p.m.