apollo_validateControl: Validates apollo_control

In apollo: Tools for Choice Model Estimation and Application

Validates apollo_control

Description

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

Usage

apollo_validateControl(database, apollo_control, silent = FALSE)

Arguments

database	data.frame. Data used by model.
apollo_control	List. Options controlling the running of the code. User input is required for all settings except those with a default or marked as optional. calculateLLC: Boolean. TRUE if user wants to calculate LL at constants (if applicable). - TRUE by default. HB: Boolean. TRUE if using RSGHB for Bayesian estimation of model. indivID: Character. Name of column in the database with each decision maker's ID. memorySaver: Boolean. TRUE to reduce memory usage when calculating analytical gradients and hessian - FALSE by default. mixing: Boolean. TRUE for models that include random parameters. modelDescr: Character. Description of the model. Used in output files. modelName: Character. Name of the model. Used when saving the output to files. nCores: Numeric>0. Number of cores to use in calculations of the model likelihood. noDiagnostics: Boolean. TRUE if user does not wish model diagnostics to be printed - FALSE by default. noValidation: Boolean. TRUE if user does not wish model input to be validated before estimation - FALSE by default. outputDirectory: Character. Optional directory for outputs if different from working director - empty by default panelData: Boolean. TRUE if there are multiple observations (i.e. rows) for each decision maker - Automatically set based on indivID by default. seed: Numeric. Seed for random number generation. 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.
silent	Boolean. If TRUE, no messages are printed to screen.

Details

This function should be run before running apollo_validateData.

Value

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

apollo documentation built on Oct. 2, 2024, 1:08 a.m.