MonolixSuite in R
Breadcrumbs

getConditionalDistributionSamplingSettings

[Monolix] Get conditional distribution sampling settings

Get the conditional distribution sampling settings for the current project.
Associated settings are:

ratio

(0 < double < 1)

Width of the relative interval for stopping criteria (i.e. 0.05 for 5%).

enableMaxIterations

(logical)

Enable maximum number of iterations if stopping criteria not met.

nbMinIterations

(integer >= 1)

Number of iterations to use for evaluating stopping criteria.

nbMaxIterations

(integer >= 1)

Maximum number of iterations if enableMaxIterations is TRUE.

nbSimulatedParameters

(integer >= 1)

Number of samples from the conditional distribution to retain per individual for plots.

Usage

R
getConditionalDistributionSamplingSettings(...)

Arguments

... [optional] (character) Name of the settings whose value should be returned. If no argument is provided, all the settings are returned.

Value

A list with each setting name mapped to its current value.

See also

setConditionalDistributionSamplingSettings

Examples

R
initializeLixoftConnectors("monolix")
loadProject(file.path(getDemoPath(), "1.creating_and_using_models", "1.1.libraries_of_models", "theophylline_project.mlxtran"))

# retrieve all the conditional distribution sampling settings
getConditionalDistributionSamplingSettings() 
#> $enablemaxiterations
#> [1] FALSE
#> 
#> $nbminiterations
#> [1] 50
#> 
#> $nbmaxiterations
#> [1] 500
#> 
#> $nbsimulatedparameters
#> [1] 10
#> 
#> $ratio
#> [1] 0.05
#> 

# retrieve only certain settings 
getConditionalDistributionSamplingSettings("ratio", "nbMinIterations") 
#> $nbminiterations
#> [1] 50
#> 
#> $ratio
#> [1] 0.05
#>