# Tools for Choice Model Estimation and Application

## Documentation for package ‘apollo’ version 0.1.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

.onAttach | Prints package startup message
apollo_addLog | Writes an entry to 'apolloLog'
apollo_attach | Attaches predefined variables.
apollo_avgInterDraws | Averages inter-individual draws
apollo_avgIntraDraws | Averages intra-individual draws
apollo_bootstrap | Bootstrap a model
apollo_choiceAnalysis | Reports market share for subsamples
apollo_cnl | Calculates probabilities of a cross nested logit
apollo_combineModels | Combines separate model components.
apollo_combineResults | Write model results to file
apollo_conditionals | Calculates conditionals
apollo_deltaMethod | Delta method
apollo_detach | Detaches parameters and the database.
apollo_dft | Calculate DFT probabilities
apollo_drugChoiceData | Simulated dataset of medication choice.
apollo_el | Calculates exploded logit probabilities
apollo_estimate | Estimates model
apollo_estimateHB | Estimates model
apollo_firstRow | Keeps only the first row for each individual
apollo_fitsTest | Compares fit of model across categories
apollo_initialise | Prepares environment
apollo_insertRows | Inserts rows
apollo_keepRows | Keeps only some rows
apollo_lc | Calculates the likelihood of a latent class model
apollo_lcConditionals | Calculates conditionals of a latent class model.
apollo_lcUnconditionals | Returns draws for random parameters in a latent class model model
apollo_llCalc | Calculates log-likelihood of all model components
apollo_loadModel | Loads model from file
apollo_lrTest | Likelihood ratio test
apollo_makeCluster | Creates cluster for estimation.
apollo_makeDraws | Creates draws for models with mixing
apollo_makeLogLike | Creates log-likelihood function.
apollo_mdcev | Calculates MDCEV likelihoods.
apollo_mdcevInside | Calculates MDCEV likelihoods without an outside good.
apollo_mdcevOutside | Calculates MDCEV likelihoods with an outside good.
apollo_mdcnev | Calculates MDCNEV likelihoods with an outside good.
apollo_mlhs | Generate random draws using MLHS algorithm
apollo_mnl | Calculates multinomial logit probabilities
apollo_mnl_2 | Calculates probabilities of a multinomial logit model.
apollo_modeChoiceData | Simulated dataset of mode choice.
apollo_modelOutput | Prints estimation results to console
apollo_nl | Calculates probabilities of a nested logit
apollo_normalDensity | Calculates density from a Normal distribution
apollo_ol | Calculates the probability of an ordered logit model
apollo_op | Calculates the probability of an ordered probit model
apollo_outOfSample | Out-of-sample fit (LL)
apollo_panelProd | Calculates product of panel observations.
apollo_prediction | Predicts using an estimated model
apollo_prepareProb | Checks likelihood
apollo_printLog | Returns the log of Apollo
apollo_readBeta | Reads parameters from file
apollo_reportModelTypeLog | Writes the type of a model inside 'apolloLog'
apollo_saveOutput | Saves estimation results to files.
apollo_searchStart | Searches for better starting values.
apollo_setRows | Sets specified rows to a given value
apollo_sharesTest | Compares predicted and observed shares
apollo_speedTest | Measures evaluation time of a model
apollo_splitDataDraws | Splits data and draws for loading in cluster
apollo_swissRouteChoiceData | Dataset of route choice.
apollo_timeUseData | Dataset of time use.
apollo_unconditionals | Returns draws for random parameters in a latent class model model
apollo_validateControl | Validates apollo_control
apollo_validateData | Validates data
apollo_validateHBControl | Validates the apollo_HB list of parameters
apollo_validateInputs | Prepares input for 'apollo_estimate'
apollo_weighting | Applies weights
apollo_writeF12 | Writes an F12 file with the results of a model estimation.
apollo_writeTheta | Writes the vector [beta,ll] to a file called modelname_iterations.csv