apollo_fmnl: Calculates Fractional Multinomial Logit probabilities

In byu-transpolab/apollo-byu: Tools for Choice Model Estimation and Application

Description

Calculates probabilities of a Fractional Multinomial Logit model.

Usage

apollo_fmnl(fmnl_settings, functionality)

Arguments

fmnl_settings

List of inputs of the FMNL model. It should contain the following. alternatives: Named numeric vector. Names of alternatives and their corresponding value in choiceVar. avail: Named list of numeric vectors or scalars. Availabilities of alternatives, one element per alternative. Names of elements must match those in alternatives. Values can be 0 or 1. choiceShares: Named list of numeric vectors. Share allocated to each alternative. One element per alternative, as long as the number of observations or a scalar. Names must match those in alternatives. V: Named list of deterministic utilities . Utilities of the alternatives. Names of elements must match those in alternatives. rows: Boolean vector. Consideration of rows in the likelihood calculation, FALSE to exclude. Length equal to the number of observations (nObs). Default is "all", equivalent to rep(TRUE, nObs). componentName: Character. Name given to model component.

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 probability of the chosen alternative.

• "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.

• "conditionals": Same as "estimate"

• "output": Same as "estimate" but also writes summary of input data to internal Apollo log.

• "raw": Same as "prediction"

byu-transpolab/apollo-byu documentation built on Dec. 19, 2021, 12:49 p.m.