Select Page

API concerning the population parameters

Description of the functions of the API

getPopulationParameterInformation Get the name, the initial value, the estimation method and, if relevant, MAP parameters value of the population parameters present in the project.
setInitialEstimatesToLastEstimates Set the initial value of all the population parameters present within the current project (fixed effects + individual variances + error model parameters) to the ones previously estimated.
setPopulationParameterInformation Set the initial value, the estimation method and, if relevant, the MAP parameters of one or several of the population parameters present within the current project (fixed effects + individual variances + error model parameters).

Get population parameters information

Description

Get the name, the initial value, the estimation method and, if relevant, MAP parameters value of the population parameters present in the project.
It is available for fixed effects, random effects, error model parameters, and latent covariates probabilities.

Usage

getPopulationParameterInformation()

Value

A data frame giving, for each population parameter, the corresponding :

  • initialValue : (double) initial value
  • method : (string) estimation method
  • priorValue : (double) [MAP] typical value
  • priorSD : (double) [MAP] standard deviation

See Also

setPopulationParameterInformation

Click here to see examples

## Not run:

info = getPopulationParameterInformation()

info

name initialValue method typicalValue stdDeviation

ka_pop 1.0 MLE NA NA

V_pop 10.0 MAP 10.0 0.5

omega_ka 1.0 FIXED NA NA

## End(Not run)

)
Top of the page, Monolix API.


Initialize population parameters with the last estimated ones

Description

Set the initial value of all the population parameters present within the current project (fixed effects + individual variances + error model parameters) to the ones previously estimated.
These the values will be used in the population parameter estimation algorithm during the next scenario run.
WARNING: If there is any set after a run, it will not be possible to set the initial values as the structure of the project has changed since last results.

Usage

setInitialEstimatesToLastEstimates()

See Also

getEstimatedPopulationParameters getPopulationParameterInformation

Click here to see examples

## Not run:

setInitialEstimatesToLastEstimates()

## End(Not run)

)
Top of the page, Monolix API.


Population parameters initialization and estimation method

Description

Set the initial value, the estimation method and, if relevant, the MAP parameters of one or several of the population parameters present within the current project (fixed effects + individual variances + error model parameters).
Available methods are:

  • "FIXED": Fixed
  • "MLE": Maximum Likelihood Estimation
  • "MAP": Maximum A Posteriori

Call getPopulationParameterInformation to get a list of the initializable population parameters present within the current project.

Usage

setPopulationParameterInformation(...)

Arguments


A list of comma-separated pairs {paramName = list( initialValue = (double), method = (string)"method"}.
In case of "MAP" method, the user can specify the associated typical value and standard deviation values by using an additional list elements {paramName = list( priorValue = (double)1, priorSD = (double)2 )}.
By default, the prior value corresponds to the the population parameter and the prior standard deviation is set to 1.

See Also

getPopulationParameterInformation

Click here to see examples

## Not run:

setPopulationParameterInformation(Cl_pop = list(initialValue = 0.5, method = “FIXED”), V_pop = list(intialValue = 1), ka_pop = list( method = “MAP”, priorValue = 1.5, priorSD = 0.25 ) )

## End(Not run)

)
Top of the page, Monolix API.