Function which initializes an empty index sheet. The function is intended to be called at the beginning of a workflow (just after the initialization of the Workbook object), and paired with the function insert_index_hyperlinks().

insert_index_sheet(
  wb,
  sheetname = "Index",
  title,
  auftrag_id,
  logo = getOption("statR_logo"),
  contactdetails = inputHelperContactInfo(),
  homepage = getOption("statR_homepage"),
  openinghours = getOption("statR_openinghours"),
  source = getOption("statR_index_source"),
  author = "user"
)

Arguments

wb

workbook object to add new worksheet to.

sheetname

Names of the worksheet in output file. Note that this name will be truncated to 31 characters, must be unique, and cannot contain some special characters (namely the following: /, \, ?, *, :, [, ]).

title

title to be put above the data.

auftrag_id

Order ID

logo

File path to the logo to be included in the index-sheet. Defaults to the logo of the Statistical Office of Kanton Zurich. This can either be overridden with a path to an image file, or configured in a user profile.

contactdetails

Character vector with contact information to be displayed on the title sheet. By default uses inputHelperContactInfo() to construct it based on values defined in the active user configuration.

homepage

Homepage of data publisher. Default can be adjusted via user configuration.

openinghours

statzh or a character string or vector with opening hours

source

source of the data. Default can be adjusted via user profiles

author

defaults to the last two letters (initials) or numbers of the internal user name.

Details

The logo can be customized via the `statR_logo` global option. This should point to the path of the logo file. Other options such as the image size in the final .xlsx can either be changed via the options `statR_logo_width` and `statR_logo_height`, or set along with contact information in a custom profile.