run_retries: run_retries

View source: R/functions_wrapper.R

run_retriesR Documentation

run_retries

Description

Run retries tool.

Usage

run_retries(
  model = NULL,
  results = NULL,
  number_of_candidates = 5,
  fraction = 0.1,
  use_initial_estimates = FALSE,
  strictness = "minimization_successful or (rounding_errors and sigdigs >= 0.1)",
  scale = "UCP",
  prefix_name = "",
  ...
)

Arguments

model

(Model (optional)) Model object to run retries on. The default is NULL.

results

(ModelfitResults (optional)) Connected ModelfitResults object. The default is NULL.

number_of_candidates

(numeric) Number of retry candidates to run. The default is 5.

fraction

(numeric) Determines allowed increase/decrease from initial parameter estimate. Default is 0.1 (10%)

use_initial_estimates

(logical) Use initial parameter estimates instead of final estimates of input model when creating candidate models.

strictness

(str) Strictness criteria. The default is "minimization_successful or (rounding_errors and sigdigs >= 0.1)".

scale

(str (optional)) Which scale to update the initial values on. Either normal scale or UCP scale.

prefix_name

(str (optional)) Prefix the candidate model names with given string

...

Arguments to pass to tool

Value

(RetriesResults) Retries tool results object.


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