Learn R Programming

apollo (version 0.3.6)

apollo_mixUnconditionals: Returns draws for continuously distributed random parameters in mixture model

Description

Returns draws (unconditionals) for random parameters in model, including interactions with deterministic covariates.

Usage

apollo_mixUnconditionals(
  model,
  apollo_probabilities,
  apollo_inputs,
  obsLevel = FALSE
)

Value

List of object, one per random coefficient. With inter-individual draws only, this will be a matrix, with one row per individual, and one column per draw. With intra-individual draws, this will be a three-dimensional array, with one row per observation, inter-individual draws in the second dimension, and intra-individual draws in the third dimension.

Arguments

model

Model object. Estimated model object as returned by function apollo_estimate.

apollo_probabilities

Function. Returns probabilities of the model to be estimated. Must receive three arguments:

  • apollo_beta: Named numeric vector. Names and values of model parameters.

  • apollo_inputs: List containing options of the model. See apollo_validateInputs.

  • functionality: Character. Can be either "components", "conditionals", "estimate" (default), "gradient", "output", "prediction", "preprocess", "raw", "report", "shares_LL", "validate" or "zero_LL".

apollo_inputs

List grouping most common inputs. Created by function apollo_validateInputs.

obsLevel

Logical. If TRUE, unconditionals are returned at the observation level rather than person level. This setting only applies to continuous mixture models and is set to TRUE by default only in the presence of intra-individual draws. Otherwise, the default is FALSE.

Details

This functions is only meant for use with continuous distributions