apollo_validateControl {apollo} | R Documentation |
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.
- 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.
|
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.
[Package
apollo version 0.0.8
Index]