Skip to main content
Skip table of contents

getModelBuildingSettings

Get the current settings for running model building. These are the settings that will be used if runModelBuilding is called without argument, or they can be used as a template to update and pass to runModelBuilding in order to change the settings.

Usage

R
getModelBuildingSettings()

Value

The list of settings (default values indicated by square brackets)

  • covariates: (vector) covariate names to be considered in the model building

  • parameters: (vector) parameters names to be considered in the model building

  • strategy: (character) strategy to use for model building (["cossac"], "samba", "covsamba", "scm"), where cossac, covsamba, and scm are algorithms for automatic covariate model building and samba is an algorithm for automatic statistical model building, which includes the residual error model and correlations between random effects in addition to the covariate effects

  • criterion: (character) criterion to determine best model (["BIC"], "LRT")

  • relationships: (data.frame with columns: parameters, covariates, locked) Use to force specific parameter-covariate relationships to be included (locked = TRUE) or excluded (locked = FALSE), See runModelBuilding for an example. By default, all the combinations are possible (i.e. this data.frame is empty).

  • threshold$lrt: threshold used by criterion LRT whether or not to continue to improve the model (first element is for forward and the second one is for the backward method)

  • threshold$correlation: threshold used by cossac to choose what combinations (parameter-covariate) must be tried as next candidate model (first element is for forward and the second one is for the backward method)

  • useLin: (logical) computation done using linearization ([TRUE]) or importance sampling (FALSE)

See also

runModelBuilding to run model building

Examples

R
initializeLixoftConnectors("monolix")
project_file <- file.path(getDemoPath(), "1.creating_and_using_models", "1.1.libraries_of_models", "theophylline_project.mlxtran")
loadProject(project_file)
getModelBuildingSettings()
#> $covariates
#> [1] "SEX"    "WEIGHT"
#> 
#> $parameters
#> [1] "ka" "V"  "Cl"
#> 
#> $criterion
#> [1] "LRT"
#> 
#> $nexttoproject
#> [1] FALSE
#> 
#> $relationships
#> [1] parameters covariates locked    
#> <0 rows> (or 0-length row.names)
#> 
#> $strategy
#> [1] "samba"
#> 
#> $threshold
#> $threshold$correlation
#> [1] 0.30 0.01
#> 
#> $threshold$lrt
#> [1] 0.05 0.01
#> 
#> 
#> $useLin
#> [1] TRUE
#> 
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.