set_initial_estimates: set_initial_estimates

View source: R/functions_wrapper.R

set_initial_estimatesR Documentation

set_initial_estimates

Description

Update initial parameter estimate for a model

Updates initial estimates of population parameters for a model. If the new initial estimates are out of bounds or NaN this function will raise.

Usage

set_initial_estimates(
  model,
  inits,
  move_est_close_to_bounds = FALSE,
  strict = TRUE
)

Arguments

model

(Model) Pharmpy model to update initial estimates

inits

(list(str=numeric)) Initial parameter estimates to update

move_est_close_to_bounds

(logical) Move estimates that are close to bounds. If correlation >0.99 the correlation will be set to 0.9, if variance is <0.001 the variance will be set to 0.01.

strict

(logical) Whether all parameters in input need to exist in the model. Default is TRUE

Value

(Model) Pharmpy model object

See Also

fix_parameters_to : Fixing and setting parameter initial estimates in the same function

unfix_paramaters_to : Unfixing parameters and setting a new initial estimate in the same

Examples

## Not run: 
model <- load_example_model("pheno")
results <- load_example_modelfit_results("pheno")
model$parameters$inits
model <- set_initial_estimates(model, results$parameter_estimates)
model$parameters$inits
model <- load_example_model("pheno")
model <- set_initial_estimates(model, list('POP_CL'=2.0))
model$parameters['POP_CL']

## End(Not run)

pharmpy/pharmr documentation built on Feb. 15, 2025, 3:22 a.m.