Skip to contents

Read scenario parameters from an Excel workbook (one sheet per scenario).

Usage

read_param(path, inparm_scene_k = 3)

Arguments

path

Excel file path that stores projection parameters by scenario (one sheet per scenario, in low/mid/high order or any user-defined order).

inparm_scene_k

Number of scenarios (sheets) to read.

Value

A list of numeric data frames, one per scenario.

Details

Required columns by order are typically: year, mex, fex, tfr, srb, move.

Examples

data("inparm_scene", package = "fastproj")
tf <- tempfile(fileext = ".xlsx")
wb <- openxlsx::createWorkbook()
openxlsx::addWorksheet(wb, "low")
openxlsx::addWorksheet(wb, "mid")
openxlsx::writeData(wb, "low", inparm_scene[[1]])
openxlsx::writeData(wb, "mid", inparm_scene[[2]])
openxlsx::saveWorkbook(wb, tf, overwrite = TRUE)
prm <- read_param(tf, inparm_scene_k = 2)
names(prm[[1]])
#> [1] "year" "mex"  "fex"  "tfr"  "srb"  "move"