apollo: apollo_validateControl – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

apollo_validateControl

Validates apollo_control

Validates the options controlling the running of the code apollo_control and sets default values for the omitted ones.

apollo_validateControl(database, apollo_control, silent = FALSE)

database

data.frame. Data used by model.

apollo_control

List. Options controlling the running of the code.

modelName: Character. Name of the model. Used when saving the output to files.
modelDescr: Character. Description of the model. Used in output files.
indivID: Character. Name of column in the database with each decision maker's ID.
mixing: Boolean. TRUE for models that include random parameters.
nCores: Numeric>0. Number of cores to use in calculations of the model likelihood.
seed: Numeric. Seed for random number generation.
HB: Boolean. TRUE if using RSGHB for Bayesian estimation of model.
noValidation: Boolean. TRUE if user does not wish model input to be validated before estimation - FALSE by default.
noDiagnostics: Boolean. TRUE if user does not wish model diagnostics to be printed - FALSE by default.
weights: Character. Name of column in database containing weights for estimation.
workInLogs: Boolean. TRUE for increased numeric precision in models with panel data - FALSE by default.
panelData: Boolean. TRUE if there are multiple obsrvations (i.e. rows) for each decision maker - Automatically set based on indivID by default.

silent

Boolean. If TRUE, no messages are printed to screen.

This function should be run before running apollo_validateData.

Validated version of apollo_control, with additional element called panelData set to TRUE for repeated choice data.

Tools for Choice Model Estimation and Application

v0.2.4

GPL-2

Authors

Stephane Hess [aut], David Palma [aut, cre]

Initial release