UPG (version 0.2.2)

predict.UPG.MNL: Predicted probabilities from UPG.MNL objects

Description

predict generates predicted probabilities from estimated discrete choice models in an UPG.MNL object. In addition, credible intervals for these probabilities are computed. Probabilities can be predicted from the data used for estimating the model or for a new data set with the same structure.

Usage

# S3 method for UPG.MNL
predict(object = NULL, ..., newdata = NULL, q = c(0.025, 0.975))

Arguments

object

an object of class UPG.MNL.

...

other predict parameters.

newdata

a matrix or a data.frame containing new explanatory data. The number of columns and the variable ordering must be the same as in the explanatory data used for estimation to generate valid predictions. If no new data is provided, predict will return predicted probabilities for the data used for estimating the model.

q

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

Value

Returns a list containing posterior means of predicted probabilities as well as the desired credible interval.

See Also

summary.UPG.MNL to summarize the estimates of a discrete choice model from an UPG.MNL object and create tables. plot.UPG.MNL to plot the results of a discrete choice model from an UPG.Logit object. coef.UPG.MNL to extract coefficients from an UPG.MNL object.

Examples

# NOT RUN {
# estimate a multinomial logit model using example data
library(UPG)
data(program)
y = program[,1]
X = program[,-1]
results.mnl = UPG(y = y, X = X, type = "mnl")

# extract predicted probabilities
predict(results.mnl)
# }