set_sheet_list_names()
and as_sheet_names()
are adapted from the existing
functionality for handling sheet names in openxlsx2::write_xlsx()
.
Usage
set_sheet_list_names(
x,
sheet_names = NULL,
...,
n_sheets = NULL,
.prep_fn = prep_wb_data,
repair = "unique",
default = "Sheet",
call = caller_env()
)
as_sheet_names(
sheet_names = NULL,
n_sheets = 1,
default = "Sheet",
max_length = 31,
excess_length = c("truncate", "error"),
repair = "unique",
quiet = FALSE,
arg = caller_arg(sheet_names),
call = caller_env()
)
Arguments
- sheet_names
One or more sheet names. Empty values ("" or " ") are replaced using the
default
parameter value and position insheet_names
vector.- n_sheets
Number of sheet names to return.
- default
Default prefix to use for numbered sheets. Default values are used if
sheet_names = NULL
or ifn_sheets
is greater than the length ofsheet_names
. Defaults to "Sheet".- max_length
Maximum allowed length in characters for sheet names. Must be 31 or less.
- excess_length
Handling for sheet names that exceed
max_length
in characters. "truncate" trims to length ofmax_length
and "error" errors.
Examples
as_sheet_names()
#> [1] "Sheet 1"
as_sheet_names("Workbook sheet")
#> [1] "Workbook sheet"
as_sheet_names(c("Workbook sheet", "Workbook sheet"), quiet = TRUE)
#> [1] "Workbook sheet...1" "Workbook sheet...2"
as_sheet_names("Workbook sheet", n_sheets = 2)
#> [1] "Workbook sheet" "Sheet 2"
as_sheet_names("Sheet names longer than 31 characters are truncated")
#> ! Truncating `"Sheet names longer than 31 characters are truncated"` values to
#> 31 characters.
#> [1] "Sheet names longer than 31 char"