UPG (version 0.2.2)

summary.UPG.Probit: Estimation results and tables for UPG.Probit objects

Description

summary generates a summary of estimation results for UPG.Probit objects. Point estimates, estimated standard deviation as well as credible intervals for each variable are tabulated. In addition, an indicator quickly shows whether the credible interval includes zero or not. In addition, LaTeX, HTML and pandoc tables can be quickly generated via knitr.

Usage

# S3 method for UPG.Probit
summary(
  object = NULL,
  ...,
  q = c(0.025, 0.975),
  names = NULL,
  digits = 2,
  include = NULL,
  table = NULL,
  cap = NULL
)

Arguments

object

an object of class UPG.Probit.

...

other summary parameters.

q

a numerical vector of length two holding the posterior quantiles to be extracted. Default are 0.025 and 0.975 quantiles.

names

a character vector indicating names for the variables used in the output.

digits

number of digits to be included in output. Last digit will be rounded using round.

include

can be used to summarize and tabulate only a subset of variables. Specificy the columns of X that should be kept in the plot. See examples for further information.

table

can be used to return a LaTeX table ('latex'), a Word table ('pandoc') and HTML tables ('html') via knitr. Include package "booktabs" in LaTeX preamble for LaTeX tables.

cap

character vector that can be used to specify the table caption is returned.

Value

Returns a knitr_kable object containing the summary table.

See Also

plot.UPG.Probit to plot the results of a discrete choice model from an UPG.Probit object. predict.UPG.Probit to predict probabilities from a discrete choice model from an UPG.Probit object. coef.UPG.Probit to extract coefficients from an UPG.Probit object.

Examples

# NOT RUN {
# estimate a probit model using example data
library(UPG)
data(lfp)
y = lfp[,1]
X = lfp[,-1]
results.probit = UPG(y = y, X = X, type = "probit", verbose=TRUE)

# basic summary of regression results
summary(results.probit)

# generate a LaTeX table with subset of variables and custom names
summary(results.probit,
        include=c(1,3),
        names=c("V. kept 1", "V. kept 3"),
        table="latex")
# }