Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free
Documentation
R
apollo

apollo_avgIntraDraws

Averages across intra-individual draws.

Description

Averages observation-specific likelihood across intra-individual draws.

Usage

apollo_avgIntraDraws(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.

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

Value

Argument P with (for most functionalities) the original contents averaged over intra-individual draws. Shape depends on argument functionality.

  • "components": Returns P without changes.

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

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

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

  • "output": Returns P containing the likelihood of all model components averaged across intra-individual draws.

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

  • "preprocess": Returns P without changes.

  • "raw": Returns P without changes.

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

  • "zero_LL": Returns P without changes.

apollo

Tools for Choice Model Estimation and Application

v0.2.4
GPL-2
Authors
Stephane Hess [aut], David Palma [aut, cre]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.