Package: apollo 0.3.8

apollo: Tools for Choice Model Estimation and Application

Choice models are a widely used technique across numerous scientific disciplines. The Apollo package is a very flexible tool for the estimation and application of choice models in R. Users are able to write their own model functions or use a mix of already available ones. Random heterogeneity, both continuous and discrete and at the level of individuals and choices, can be incorporated for all models. There is support for both standalone models and hybrid model structures. Both classical and Bayesian estimation is available, and multiple discrete continuous models are covered in addition to discrete choice. Multi-threading processing is supported for estimation and a large number of pre and post-estimation routines, including for computing posterior (individual-level) distributions are available. For examples, a manual, and a support forum, visit <https://www.ApolloChoiceModelling.com>. For more information on choice models see Train, K. (2009) <isbn:978-0-521-74738-7> and Hess, S. & Daly, A.J. (2014) <isbn:978-1-781-00314-5> for an overview of the field.

Authors:Stephane Hess [aut, cre], David Palma [aut], Thomas Hancock [ctb]

apollo_0.3.8.tar.gz
apollo_0.3.8.zip(r-4.7)apollo_0.3.8.zip(r-4.6)apollo_0.3.8.zip(r-4.5)
apollo_0.3.8.tgz(r-4.6-x86_64)apollo_0.3.8.tgz(r-4.6-arm64)apollo_0.3.8.tgz(r-4.5-x86_64)apollo_0.3.8.tgz(r-4.5-arm64)
apollo_0.3.8.tar.gz(r-4.7-arm64)apollo_0.3.8.tar.gz(r-4.7-x86_64)apollo_0.3.8.tar.gz(r-4.6-arm64)apollo_0.3.8.tar.gz(r-4.6-x86_64)
apollo_0.3.8.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
apollo/json (API)

# Install 'apollo' in R:

install.packages('apollo', repos = c('https://stephanehess.r-universe.dev', 'https://cloud.r-project.org'))

Uses libs:

openblas– Optimized BLAS
c++– GNU Standard C++ Library v3
openmp– GCC OpenMP (GOMP) support library

Datasets:

apollo_drugChoiceData - Simulated dataset of medication choice.
apollo_modeChoiceData - Simulated dataset of mode choice.
apollo_swissRouteChoiceData - Dataset of route choice.
apollo_timeUseData - Dataset of time use.

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

openblas cpp openmp

6.33 score 4 stars 1 packages 522 scripts 3.8k downloads 3 mentions 97 exports 48 dependencies

Last updated from:6720307b8b. Checks:13 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	OK	248
linux-devel-x86_64	OK	217
source / vignettes	OK	369
linux-release-arm64	OK	210
linux-release-x86_64	OK	224
macos-release-arm64	OK	294
macos-release-x86_64	OK	305
macos-oldrel-arm64	OK	230
macos-oldrel-x86_64	OK	393
windows-devel	OK	212
windows-release	OK	229
windows-oldrel	OK	188
wasm-release	OK	129

Exports:apollo_addCovariance apollo_attach apollo_avgInterDraws apollo_avgIntraDraws apollo_basTest apollo_bootstrap apollo_checkArguments apollo_choiceAnalysis apollo_classAlloc apollo_cnl apollo_cnl2 apollo_combineModels apollo_combineResults apollo_compareInputs apollo_conditionals apollo_deltaMethod apollo_detach apollo_dft apollo_diagnostics apollo_dVdB apollo_dVdBOld apollo_el apollo_emdc apollo_emdc1 apollo_emdc2 apollo_estimate apollo_estimateHB apollo_expandLoop apollo_firstRow apollo_fitsTest apollo_fmnl apollo_fnl apollo_initialise apollo_insertComponentName apollo_insertFunc apollo_insertOLList apollo_insertRows apollo_insertRRMQuotes apollo_insertScaling apollo_keepRows apollo_lc apollo_lcConditionals apollo_lcEM apollo_lcUnconditionals apollo_llCalc apollo_loadModel apollo_longToWide apollo_lrTest apollo_makeCluster apollo_makeDraws apollo_makeGrad apollo_makeHessian apollo_makeLogLike apollo_mdcev apollo_mdcev2 apollo_mdcnev apollo_mixConditionals apollo_mixEM apollo_mixUnconditionals apollo_mlhs apollo_mnl apollo_modelOutput apollo_modifyUserDefFunc apollo_nl apollo_normalDensity apollo_ol apollo_op apollo_outOfSample apollo_ownModel apollo_panelProd apollo_prediction apollo_preEstimate apollo_prepareProb apollo_preprocess apollo_print apollo_readBeta apollo_rrm apollo_saveOutput apollo_searchStart apollo_setRows apollo_setWorkDir apollo_sharesTest apollo_sink apollo_speedTest apollo_tobit apollo_unconditionals apollo_validate apollo_validateControl apollo_validateData apollo_validateHBControl apollo_validateInputs apollo_varcov apollo_varList apollo_weighting apollo_writeF12 apollo_writeTheta aux_validateRows

Dependencies:bgw cli coda codetools Deriv digest future future.apply generics globals glue lattice lifecycle listenv magrittr MASS Matrix MatrixModels matrixStats maxLik mcmc MCMCpack miscTools mnormt mvtnorm numDeriv parallelly pillar pkgconfig quantreg randtoolbox Rcpp RcppArmadillo RcppEigen rlang rngWELL Rsolnp rstudioapi sandwich SparseM stringi stringr survival tibble truncnorm utf8 vctrs zoo

Model file examples

About the package | Recommended workflow | MNL model file example | MMNL model file example | References

Rendered fromapollofirstexample.Rmdusingknitr::rmarkdown

Last update: 2021-07-31
Started: 2019-03-13

Help page	Topics
Prints package startup message	.onAttach
Adds covariance matrix to Apollo model	apollo_addCovariance
Attaches predefined variables.	apollo_attach
Averages across inter-individual draws.	apollo_avgInterDraws
Averages across intra-individual draws.	apollo_avgIntraDraws
Ben-Akiva & Swait test	apollo_basTest
Bootstrap a model	apollo_bootstrap
Checks definitions of Apollo functions	apollo_checkArguments
Reports market share for subsamples	apollo_choiceAnalysis
Calculates class allocation probabilities for a Latent Class model	apollo_classAlloc
Calculates Cross-Nested Logit probabilities	apollo_cnl
Calculates Cross-Nested Logit probabilities	apollo_cnl2
Combines separate model components.	apollo_combineModels
Write model results to file	apollo_combineResults
Compares the content of apollo_inputs to their counterparts in the global environment	apollo_compareInputs
Calculates conditionals	apollo_conditionals
Delta method for Apollo models	apollo_deltaMethod
Detaches parameters and the database.	apollo_detach
Calculate DFT probabilities	apollo_dft
Pre-process input for common models return	apollo_diagnostics
Simulated dataset of medication choice.	apollo_drugChoiceData
Calculates gradients of utility functions	apollo_dVdB
Calculates gradients of utility functions	apollo_dVdBOld
Calculates Exploded Logit probabilities	apollo_el
MDC model with exogenous budget	apollo_emdc
MDC model with exogenous budget	apollo_emdc1
Extended MDC	apollo_emdc2
Estimates model	apollo_estimate
Estimates model using Bayesian estimation	apollo_estimateHB
Expands loops in a function or expression	apollo_expandLoop
Keeps only the first row for each individual	apollo_firstRow
Compares log-likelihood of model across categories	apollo_fitsTest
Calculates Fractional Multinomial Logit probabilities	apollo_fmnl
Calculates Fractional Nested Logit probabilities	apollo_fnl
Prepares environment	apollo_initialise
Adds componentName2 to model calls	apollo_insertComponentName
Modifies function to make it compatible with analytic gradients	apollo_insertFunc
Replaces 'tau=c(...)' by 'tau=list(...)' in calls to 'apollo_ol'	apollo_insertOLList
Inserts rows	apollo_insertRows
Introduces quotes into rrm_settings	apollo_insertRRMQuotes
Scales variables inside a function	apollo_insertScaling
Keeps only some rows	apollo_keepRows
Calculates the likelihood of a latent class model	apollo_lc
Calculates conditionals for latent class models.	apollo_lcConditionals
Uses EM for latent class model	apollo_lcEM
Uses EM for latent class model	apollo_lcEM_new
Returns unconditionals for a latent class model model	apollo_lcUnconditionals
Calculates log-likelihood of all model components	apollo_llCalc
Loads model from file	apollo_loadModel
Converts data from long to wide format.	apollo_longToWide
Likelihood ratio test	apollo_lrTest
Creates cluster for estimation.	apollo_makeCluster
Creates draws for models with mixing	apollo_makeDraws
Creates gradient function.	apollo_makeGrad
Creates hessian function.	apollo_makeHessian
Creates log-likelihood function.	apollo_makeLogLike
Calculates MDCEV likelihoods	apollo_mdcev
Calculates MDCEV likelihoods	apollo_mdcev2
Calculates MDCNEV likelihoods	apollo_mdcnev
Calculates conditionals for continuous mixture models	apollo_mixConditionals
Uses EM for models with continuous random coefficients	apollo_mixEM
Returns draws for continuously distributed random parameters in mixture model	apollo_mixUnconditionals
Generate random draws using MLHS algorithm	apollo_mlhs
Calculates Multinomial Logit probabilities	apollo_mnl
Simulated dataset of mode choice.	apollo_modeChoiceData
Prints estimation results to console	apollo_modelOutput
Checks and modifies Apollo user-defined functions	apollo_modifyUserDefFunc
Calculates Nested Logit probabilities	apollo_nl
Calculates density for a Normal distribution	apollo_normalDensity
Calculates Ordered Logit probabilities	apollo_ol
Calculates Ordered Probit probabilities	apollo_op
Cross-validation of fit (LL)	apollo_outOfSample
Calculates own model probabilities	apollo_ownModel
Calculates product across observations from same individual.	apollo_panelProd
Predicts using an estimated model	apollo_prediction
Conducts all the pre-estimation steps for a model	apollo_preEstimate
Checks likelihood function	apollo_prepareProb
Pre-process input for multiple models return	apollo_preprocess
Prints message to terminal	apollo_print
Reads parameters from file	apollo_readBeta
Calculates Random Regret Minimisation model probabilities	apollo_rrm
Saves estimation results to files.	apollo_saveOutput
Searches for better starting values.	apollo_searchStart
Sets specified rows to a given value	apollo_setRows
Automatically sets working directory to active file directory	apollo_setWorkDir
Compares predicted and observed shares	apollo_sharesTest
Starts or stops writing output to a text file.	apollo_sink
Measures evaluation time of a model	apollo_speedTest
Dataset of route choice.	apollo_swissRouteChoiceData
Dataset of time use.	apollo_timeUseData
Calculates density for a Tobit model (censored Normal)	apollo_tobit
Returns unconditionals for models with random heterogeneity	apollo_unconditionals
Pre-process input for common models return	apollo_validate
Validates apollo_control	apollo_validateControl
Validates data	apollo_validateData
Validates the 'apollo_HB' list of parameters	apollo_validateHBControl
Prepares input for 'apollo_estimate'	apollo_validateInputs
Calculates variance-covariance matrix of an Apollo model	apollo_varcov
Lists variable names and definitions used inside a function	apollo_varList
Applies weights	apollo_weighting
Writes an F12 file	apollo_writeF12
Writes the vector [beta,ll] to a file called 'modelname_iterations.csv'	apollo_writeTheta
Validates and expands rows if necessary.	aux_validateRows
Prints brief summary of Apollo model	print.apollo
Prints summary of Apollo model	summary.apollo

Package: apollo 0.3.8

apollo: Tools for Choice Model Estimation and Application

Citation

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)