apollo_checkArguments: Checks definitions of Apollo functions

In apollo: Tools for Choice Model Estimation and Application

Checks definitions of Apollo functions

Description

Checks that the user-defined functions used by Apollo are correctly defined by the user.

Usage

apollo_checkArguments(
  apollo_probabilities = NA,
  apollo_randCoeff = NA,
  apollo_lcPars = NA
)

Arguments

apollo_probabilities	Function. Likelihood function as defined by the user.
apollo_randCoeff	Function. Used with mixing models. Constructs the random parameters of a mixing model. Receives two arguments: apollo_beta: Named numeric vector. Names and values of model parameters. apollo_inputs: The output of this function (apollo_validateInputs).
apollo_lcPars	Function. Used with latent class models. Constructs a list of parameters for each latent class. Receives two arguments: apollo_beta: Named numeric vector. Names and values of model parameters. apollo_inputs: The output of this function (apollo_validateInputs).

Details

It only checks that the functions have the correct definition of inputs. It does not run the functions.

Value

Returns (invisibly) TRUE if definitions are correct, and FALSE otherwise.

apollo documentation built on Oct. 13, 2023, 1:15 a.m.