run_ruvsearch#

pharmpy.tools.run_ruvsearch(model=None, results=None, groups=4, p_value=0.001, skip=None, max_iter=3, dv=None, strictness='minimization_successful or (rounding_errors and sigdigs>=0.1)', **kwargs)#

Run the ruvsearch tool. For more details, see ruvsearch.

Parameters:

  • model (Model) – Pharmpy model

  • results (ModelfitResults) – Results of model

  • groups (int) – The number of bins to use for the time varying models

  • p_value (float) – The p-value to use for the likelihood ratio test

  • skip (list of {‘IIV_on_RUV’, ‘power’, ‘combined’, ‘time_varying’}) – A list of models to not attempt.

  • max_iter (int) – Number of iterations to run (1, 2, or 3). For models with BLQ only one iteration is supported.

  • dv (int) – Which DV to assess the error model for.

  • strictness (str or None) – Strictness criteri

  • kwargs – Arguments to pass to tool

Returns:

RUVSearchResults – Ruvsearch tool result object

Examples

>>> from pharmpy.modeling import load_example_model
>>> from pharmpy.tools import run_ruvsearch, load_example_modelfit_results
>>> model = load_example_model("pheno")
>>> results = load_example_modelfit_results("pheno")
>>> run_ruvsearch(model=model, results=results)
On this page