MonolixSuite in R
Breadcrumbs

getLogLikelihoodEstimationSettings

[Monolix] Get Log-likelihood algorithm settings

Get the log-likelihood estimation settings of the current project. Associated settings are:

nbFixedIterations

(integer > 0)

Monte Carlo size for importance sampling.

samplingMethod

(character)

Should the log-likelihood estimation use a given number of degrees of freedom ("fixed") or test a sequence of degrees of freedom numbers before choosing the best one ("optimized").

nbFreedomDegrees

(integer > 0)

Degree of freedom of the Student's t-distribution. Used only if "samplingMethod" is "fixed".

freedomDegreesSampling

(vector 0>)

Sequence of degrees of freedom of the Student's t-distribution to be tested. Used only if "samplingMethod" is "optimized".

Usage

R
getLogLikelihoodEstimationSettings(...)

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

setLogLikelihoodEstimationSettings

Examples

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

# retrieve a list of all the loglikelihood estimation settings
getLogLikelihoodEstimationSettings() 
#> $nbfixediterations
#> [1] 10000
#> 
#> $nbfreedomdegrees
#> [1] 5
#> 
#> $freedomdegreessampling
#> [1]  1  2  5 10 15
#> 
#> $samplingmethod
#> [1] "fixed"
#> 

# retrieve only certain settings values
getLogLikelihoodEstimationSettings("nbFixedIterations", "samplingMethod") 
#> $nbfixediterations
#> [1] 10000
#> 
#> $samplingmethod
#> [1] "fixed"
#>