Set simulation variables in model controls

Set simulation variables in model controls

Usage

set_vars_sim(model_controls, vars_sim, simulate = TRUE, exclusive = FALSE)

Arguments

model_controls

data.frame; model configuration, typically loaded via get_model_controls().

vars_sim

character vector of variable names to set for simulation

simulate

logical, whether to simulate the variables in vars_sim

exclusive

logical, if TRUE, set all other variables to not simulate

Value

Updated model_controls data frame

Examples

model_controls <- data.frame(
 var_aeme = c("HYD_temp", "CHM_oxy", "PHS_tp"),
 simulate = c(TRUE, FALSE, TRUE),
 inf_default = c(NA, NA, NA),
 initial_wc = c(NA, NA, NA),
 initial_sed = c(NA, NA, NA),
 conversion_aed = c(1, 1, 1),
 stringsAsFactors = FALSE
)
vars_sim <- c("CHM_oxy", "NIT_tn", "PHS_tp")
updated_controls <- set_vars_sim(model_controls, vars_sim, simulate = TRUE)
#> ℹ Variables not found: NIT_tn . Adding them to model_controls.
print(updated_controls)
#> <model_controls> 4/4 variables simulated
#>  var_aeme simulate inf_default initial_wc initial_sed conversion_aed
#>   CHM_oxy      yes           -          -           -              1
#>  HYD_temp      yes           -          -           -              1
#>    NIT_tn      yes           -          -           -              1
#>    PHS_tp      yes           -          -           -              1