Learn R Programming

apollo (version 0.2.6)

apollo_classAlloc: Calculates Multinomial Logit probabilities

Description

Calculates probabilities of a Multinomial Logit model.

Usage

apollo_classAlloc(classAlloc_settings)

Arguments

classAlloc_settings

List of inputs of the MNL model. It should contain the following.

  • V: Named list of deterministic utilities . Utilities of the classes in class allocation model. Names of elements must match those in avail, if provided.

  • avail: Named list of numeric vectors or scalars. Availabilities of classes in class allocation model, one element per class Names of elements must match those in V. Values can be 0 or 1.

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

Value

The returned object depends on the value of argument functionality, which it fetches from the calling stack.

  • "estimate": vector/matrix/array. Returns the probabilities for all classes

  • "prediction": Same as "estimate".

  • "validate": Same as "estimate", but it also runs a set of tests to validate the function inputs.

  • "zero_LL": Returns a scalar NA.

  • "conditionals": Same as "estimate".

  • "components": Same as "estimate".

  • "output": Same as "estimate".

  • "raw": Same as "estimate".

  • "repor": Same as "estimate".