Skip to contents

Update parameter values in param based on best_pars

Usage

update_param(
  calib,
  param = NULL,
  na_value = NULL,
  aeme = NULL,
  replace = FALSE,
  quantile = 0.1,
  fit_col = "fit",
  best_pars = NULL
)

Arguments

calib

A list with the calibration results loaded using read_calib.

param

A data frame with parameters to update. Defaults to NULL. When NULL, the parameter values are extracted from calib$parameter_metadata.

na_value

The value to replace NA values with. Defaults to NULL. When NULL, the value is extracted from calib$calibration_metadata$na_value.

aeme

aeme; object. Defaults to NULL. When NULL, a dataframe of the updated parameter values is returned. When provided, the updated parameter values are added to the aeme object and the aeme object is returned.

replace

Logical. If TRUE, the parameter values in the aeme object are replaced with the updated values. Defaults to FALSE. Only used when aeme is provided.

quantile

The quantile to use for the top quantile of the fit_value. Defaults to 0.1.

fit_col

character; name of column containing fit values. Default is "fit".

best_pars

A data frame with the best parameters from get_param. Defaults to NULL. When NULL, get_param is called to get the best parameters.

Value

data frame with updated parameter values for running the model with run_aeme_param