apollo (version 0.0.8)

apollo_lc: Calculates the likelihood of a latent class model

Description

Using the conditional likelihoods of each latent class, as well as teir classification probabilities, calculate the weighted likelihood of the whole model.

Usage

apollo_lc(lc_settings, apollo_inputs, functionality)

Arguments

lc_settings

List of arguments used by apollo_lc. It must include the following.

• inClassProb: List of probabilities. Conditional likelihood for each class. One element per class, in the same order as classProb.

• classProb: List of probabilities. Allocation probability for each class. One element per class, in the same order as inClassProb.

apollo_inputs

List grouping most common inputs. Created by function apollo_validateInputs.

functionality

Character. Can take different values depending on desired output.

• "estimate" Used for model estimation.

• "prediction" Used for model predictions.

• "validate" Used for validating input.

• "zero_LL" Used for calculating null likelihood.

• "conditionals" Used for calculating conditionals.

• "output" Used for preparing output after model estimation.

• "raw" Used for debugging.

Value

The returned object depends on the value of argument functionality as follows.

• "estimate": vector/matrix/array. Returns the probabilities for the chosen alternative for each observation.

• "prediction": List of vectors/matrices/arrays. Returns a list with the probabilities for all alternatives, with an extra element for the chosen alternative probability.

• "validate": Boolean. Returns TRUE if all tests are passed.

• "zero_LL": vector/matrix/array. Returns the probability of the chosen alternative when all parameters are zero.

• "conditionals": Same as "prediction".

• "output": Same as "estimate" but also writes summary of choices into temporary file (later read by apollo_modelOutput).

• "raw": Same as "prediction".

Examples

# NOT RUN {
data(apollo_modeChoiceData)
database <- apollo_modeChoiceData
rm(apollo_modeChoiceData)
N <- nrow(database)
lc_settings <- list(inClassProb=list(rnorm(N), rnorm(N)),
                    classProb=list(stats::runif(N), stats::runif(N)))
apollo_control <- list(indivID="ID")
x <- apollo_lc(lc_settings, apollo_control, functionality="estimate")
summary(x)
# }