apollo_panelProd: Calculates product across observations from same individual.

In apollo: Tools for Choice Model Estimation and Application

Calculates product across observations from same individual.

Description

Multiplies likelihood of observations from the same individual, or adds the log of them.

Usage

apollo_panelProd(P, apollo_inputs, functionality)

Arguments

P	List of vectors, matrices or 3-dim arrays. Likelihood of the model components.
apollo_inputs	List grouping most common inputs. Created by function apollo_validateInputs.
functionality	Character. Setting instructing Apollo what processing to apply to the likelihood function. This is in general controlled by the functions that call apollo_probabilities, though the user can also call apollo_probabilities manually with a given functionality for testing/debugging. Possible values are: "components": For further processing/debugging, produces likelihood for each model component (if multiple components are present), at the level of individual draws and observations. "conditionals": For conditionals, produces likelihood of the full model, at the level of individual inter-individual draws. "estimate": For model estimation, produces likelihood of the full model, at the level of individual decision-makers, after averaging across draws. "gradient": For model estimation, produces analytical gradients of the likelihood, where possible. "output": Prepares output for post-estimation reporting. "prediction": For model prediction, produces probabilities for individual alternatives and individual model components (if multiple components are present) at the level of an observation, after averaging across draws. "preprocess": Prepares likelihood functions for use in estimation. "raw": For debugging, produces probabilities of all alternatives and individual model components at the level of an observation, at the level of individual draws. "report": Prepares output summarising model and choiceset structure. "shares_LL": Produces overall model likelihood with constants only. "validate": Validates model specification, produces likelihood of the full model, at the level of individual decision-makers, after averaging across draws. "zero_LL": Produces overall model likelihood with all parameters at zero.

Details

This function should be called inside apollo_probabilities only if the data has a panel structure. It should be called after apollo_avgIntraDraws if intra-individual draws are used.

Value

Argument P with (for most functionalities) the original contents after multiplying across observations at the individual level. Shape depends on argument functionality.

• "components": Returns P without changes.

• "conditionals": Returns P without averaging across draws. Drops all components except "model".

• "estimate": Returns P containing the likelihood of the model after multiplying observations at the individual level. Drops all components except "model".

• "gradient": Returns P containing the gradient of the likelihood after applying the product rule across observations for the same individual.

• "output": Returns P containing the likelihood of the model after multiplying observations at the individual level.

• "prediction": Returns P containing the probabilities/likelihoods of all alternatives for all model components averaged across inter-individual draws.

• "preprocess": Returns P without changes.

• "raw": Returns P without changes.

• "report": Returns P without changes.

• "shares_LL": Returns P containing the likelihood of the model after multiplying observations at the individual level.

• "validate": Returns P containing the likelihood of the model averaged across inter-individual draws. Drops all components except "model".

• "zero_LL": Returns P containing the likelihood of the model after multiplying observations at the individual level.

apollo documentation built on Oct. 2, 2024, 1:08 a.m.