apollo_mdcev {apollo}  R Documentation 
Calculates MDCEV likelihoods
Description
Calculates the likelihoods of a Multiple Discrete Continuous Extreme Value (MDCEV) model and can also perform other operations based on the value of the functionality
argument.
Usage
apollo_mdcev(mdcev_settings, functionality)
Arguments
mdcev_settings 
List. Contains settings for this function. User input is required for all settings except those with a default or marked as optional.

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 observed consumption for each observation. 
"gradient"
: Not implemented 
"output"
: Same as"estimate"
but also writes summary of input data to internal Apollo log. 
"prediction"
: A matrix with one row per observation, and columns indicating means and s.d. of continuous and discrete predicted consumptions. 
"preprocess"
: Returns a list with preprocessed inputs, based onmdcev_settings
. 
"raw"
: Same as"estimate"

"report"
: Dependent variable overview. 
"shares_LL"
: Not implemented. Returns a vector of NA with as many elements as observations. 
"validate"
: Same as"estimate"
, but it also runs a set of tests to validate the function inputs. 
"zero_LL"
: Not implemented. Returns a vector of NA with as many elements as observations.