Calculates apollo_probabilities with functionality="prediction" and extracts one element from the returned list.
apollo_prediction(
model,
apollo_probabilities,
apollo_inputs,
prediction_settings = list(),
modelComponent = NA
)Model object. Estimated model object as returned by function apollo_estimate.
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 "estimate" (default), "prediction", "validate", "conditionals", "zero_LL", "shares_LL", or "raw".
List grouping most common inputs. Created by function apollo_validateInputs.
List of settings. It can have the following elements.
modelComponent Character. Name of component of apollo_probabilities output to calculate predictions for. Default is "model", i.e. the whole model.
runs Numeric. Number of runs to use for computing confidence intervals of predictions.
silent Boolean. If TRUE, this function won't print any output to screen.
nRep Scalar integer. Only used for models that require simulation for prediction (e.g. MDCEV). Number of draws used to calculate prediction. Default is 100.
summary Boolean. If TRUE, a summary of the prediction is printed to screen. TRUE by default.
Deprecated. Same as modelComponent inside prediction_settings.
A list containing predictions for component modelComponent of the model described in apollo_probabilities.
The particular shape of the prediction will depend on the model component.
Structure of predictions are simplified before returning, e.g. list of vectors are turned into a matrix.