Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free
Documentation
R
apollo

apollo_saveOutput

Saves estimation results to files.

Description

Writes files in the working directory with the estimation results.

Usage

apollo_saveOutput(model, saveOutput_settings = NA)

Arguments

model

Model object. Estimated model object as returned by function apollo_estimate.
saveOutput_settings

List of options. Valid options are the following.

  • printClassical: Boolean. TRUE for printing classical standard errors. TRUE by default.

  • printPVal: Boolean or Scalar. TRUE or 1 for printing p-values for one-sided test, 2 for printing p-values for two-sided test, FALSE for not printing p-values. FALSE by default.

  • printT1: Boolean. If TRUE, t-test for H0: apollo_beta=1 are printed. FALSE by default.

  • printDataReport: Boolean. TRUE for printing summary of choices in database and other diagnostics. FALSE by default.

  • printModelStructure: Boolean. TRUE for printing model structure. TRUE by default.

  • printCovar: Boolean. TRUE for printing parameters covariance matrix. If printClassical=TRUE, both classical and robust matrices are printed. TRUE by default.

  • printCorr: Boolean. TRUE for printing parameters correlation matrix. If printClassical=TRUE, both classical and robust matrices are printed. TRUE by default.

  • printOutliers: Boolean or Scalar. TRUE for printing 20 individuals with worst average fit across observations. FALSE by default. If Scalar is given, this replaces the default of 20.

  • printChange: Boolean. TRUE for printing difference between starting values and estimates. TRUE by default.

  • printFunctions: Boolean. TRUE for printing apollo_control, apollo_randCoeff (when available), apollo_lcPars (when available) and apollo_probabilities. TRUE by default.

  • saveEst: Boolean. TRUE for saving estimated parameters and standard errors to a CSV file. TRUE by default.

  • saveCov: Boolean. TRUE for saving estimated correlation matrix to a CSV file. TRUE by default.

  • saveCorr: Boolean. TRUE for saving estimated correlation matrix to a CSV file. TRUE by default.

  • saveModelObject: Boolean. TRUE to save the R model object to a file (use apollo_loadModel to load it to memory). TRUE by default.

  • writeF12: Boolean. TRUE for writing results into an F12 file (ALOGIT format). FALSE by default.

Details

Estimation results are printed to different files in the working directory:

  • (modelName)_output.txt Text file with the output produced by function apollo_modelOutput.

  • (modelName)_estimates.csv CSV file with the estimated parameter values, their standars errors, and t-ratios.

  • (modelName)_covar.csv CSV file with the estimated classical covariance matrix. Only when bayesian estimation was not used.

  • (modelName)_robcovar.csv CSV file with the estimated robust covariance matrix. Only when bayesian estimation was not used.

  • (modelName)_corr.csv CSV file with the estimated classical correlation matrix. Only when bayesian estimation was not used.

  • (modelName)_robcorr.csv CSV file with the estimated robust correlation matrix. Only when bayesian estimation was not used.

  • (modelName).F12 F12 file with model results. Compatible with ALOGIT.

Value

nothing

apollo

Tools for Choice Model Estimation and Application

v0.2.4
GPL-2
Authors
Stephane Hess [aut], David Palma [aut, cre]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.