apollo_fmnl {apollo}  R Documentation 
Calculates Fractional Multinomial Logit probabilities
Description
Calculates the probabilities of a Fractional Multinomial Logit model and can also perform other operations based on the value of the functionality
argument.
Usage
apollo_fmnl(fmnl_settings, functionality)
Arguments
fmnl_settings 
List of inputs of the FMNL model. It should contain the following.

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"
: Same as"estimate"

"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 alternatives, with an extra element for the probability of the chosen alternative. 
"preprocess"
: Returns a list with preprocessed inputs, based onfmnl_settings
. 
"raw"
: Same as"prediction"

"report"
: Overview of dependent variable 
"shares_LL"
: vector/matrix/array. Returns the probability of the chosen alternative when only constants are estimated. 
"validate"
: Same as"estimate"
, but it also runs a set of tests to validate the function inputs. 
"zero_LL"
: vector/matrix/array. Returns the probability of the chosen alternative when all parameters are zero.