Learn R Programming

apollo (version 0.2.6)

apollo_validateHBControl: Validates the apollo_HB list of parameters

Description

Validates the apollo_HB list of parameters and sets default values for the omitted ones.

Usage

apollo_validateHBControl(
  apollo_HB,
  apollo_beta,
  apollo_fixed,
  apollo_control,
  silent = FALSE
)

Arguments

apollo_HB

List. Contains options for bayesian estimation. See doHB for details. Parameters modelname, gVarNamesFixed, gVarNamesNormal, gDIST, svN and FC are automatically set based on the other arguments of this function. It should also include a named character vector called hbDist identifying the distribution of each parameter to be estimated. Possible values are as follows.

  • "F": Fixed - parameter kept at its starting value (not estimated).

  • "NR": Non-random parameter, i.e. with a generic value across individuals.

  • "N": Normal.

  • "LN+": Positive log-normal.

  • "LN-": Negative log-normal.

  • "CN+": Positive censored normal.

  • "CN-": Negative censored normal.

  • "JSB": Johnson SB.

apollo_beta

Named numeric vector. Names and values for parameters.

apollo_fixed

Character vector. Names (as defined in apollo_beta) of parameters whose value should not change during estimation. value is constant throughout estimation).

apollo_control

List. Options controlling the running of the code. See apollo_validateInputs.

silent

Boolean. TRUE to keep the function from printing to the console. Default is FALSE.

Value

Validated apollo_HB

Details

This function is only necessary when using bayesian estimation.