apollo_lc {apollo} | R Documentation |
Calculates the likelihood of a latent class model
Description
Given within class probabilities, and class allocation probabilities, calculates the probabilities of an Exploded Logit model and can also perform other operations based on the value of the functionality
argument.
Usage
apollo_lc(lc_settings, apollo_inputs, functionality)
Arguments
lc_settings |
List. Contains settings for this function. User input is required for all settings except those with a default or marked as optional.
|
apollo_inputs |
List grouping most common inputs. Created by function apollo_validateInputs. |
functionality |
Character. Setting instructing Apollo what processing to apply to the likelihood function. This is in general controlled by the functions that call
|
Value
The returned object depends on the value of argument functionality
as follows.
-
"components"
: Returns nothing. -
"conditionals"
: Same as"estimate"
-
"estimate"
: vector/matrix/array. Returns the probabilities for the chosen alternative for each observation. -
"gradient"
: List containing the likelihood and gradient of the model component. -
"output"
: Same as"estimate"
but also writes summary of input data to internal Apollo log. -
"prediction"
: List of vectors/matrices/arrays. Returns a list with the probabilities for all models components, for each class. -
"preprocess"
: Returns a list with pre-processed inputs, based onlc_settings
. -
"raw"
: Same as"prediction"
-
"report"
: Class allocation overview. -
"shares_LL"
: Same as"estimate"
-
"validate"
: Same as"estimate"
, but also runs a set of tests on the given arguments. -
"zero_LL"
: Same as"estimate"