apollo_prediction: Predicts using an estimated model

Description Usage Arguments Details Value

View source: R/apollo_prediction.R

Description

Calculates apollo_probabilities with functionality="prediction" and extracts one element from the returned list.

Usage

1
2
apollo_prediction(model, apollo_probabilities, apollo_inputs,
  modelComponent = "model")

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 "estimate" (default), "prediction", "validate", "conditionals", "zero_LL", or "raw".

apollo_inputs

List grouping most common inputs. Created by function apollo_validateInputs.

modelComponent

Character. Name of component of apollo_probabilities output to calculate predictions for. Default is "model", i.e. the whole model.

Details

Structure of predictions are simplified before returning, e.g. list of vectors are turned into a matrix.

Value

A vector containing predictions for component modelComponent of the model described in apollo_probabilities.


apollo documentation built on Oct. 30, 2019, 12:10 p.m.