apollo_el {apollo} | R Documentation |
Calculates the probabilities of an Exploded Logit model and can also perform other operations based on the value of the functionality
argument.
The function calculates the probability of a ranking as a product of Multinomial Logit models with gradually reducing availability, where scale differences can be allowed for.
apollo_el(el_settings, functionality)
el_settings |
List of inputs of the Exploded Logit model. It shoud contain the following.
|
functionality |
Character. Can take different values depending on desired output.
|
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"
: Not applicable (NA
).
"validate"
: Same as "estimate"
"zero_LL"
: vector/matrix/array. Returns the probability of the chosen alternative when all parameters are zero.
"conditionals"
: Same as "estimate"
"output"
: Same as "estimate"
but also writes summary of input data to internal Apollo log.
"raw"
: Same as "estimate"