Skip to contents

Reads the observations and locations sheets from a single Excel workbook into data frames. Reports every missing sheet at once (mirroring check_all_inputs() semantics) rather than failing on the first.

Sheet names are matched case-insensitively against the required IMURUN_SHEETS. Uses the 'openxlsx2' package.

A target sheet (IMURUN_TARGET_SHEET) is also required and returned as a target element. Generated workbooks additionally include a configuration sheet containing sampler settings; it is returned as config when present. Older workbooks without it retain the package defaults.

Usage

read_workbook(path)

Arguments

path

character; path to a .xlsx workbook.

Value

A named list with elements obs, locs, and target, plus config when the workbook has a configuration sheet (each a data.frame).

Examples

wb <- system.file("extdata", "imurun_example.xlsx", package = "imuRUN")
if (nzchar(wb)) {
  inputs <- read_workbook(wb)
  names(inputs)
}
#> [1] "obs"    "locs"   "target" "config"