predict.sbchoice: Predicting model for sbchoice

View source: R/predict.sbchoice.R

predict.sbchoiceR Documentation

Predicting model for sbchoice

Description

Predicting method for objects of class "sbchoice".

Usage

## S3 method for class 'sbchoice'
predict(object, newdata = NULL, type = c("utility", "probability"), 
...)

Arguments

object

an object of class "sbchoice".

newdata

a data frame containing new data to predict. If NULL, the original data is used.

type

type of prediction (utility or probability).

...

optional arguments. Currently not in use.

Details

The function predict() for S3 object "sbchoice" calculates predicted values according to the fitted model that is included in object. The values are predicted with the original data used for fitting the model if newdata = NULL, otherwise with a new data assigned to newdata.

The current function does not estimate standard errors of predicted values.

Value

When newdata = NULL and type = utility, a vector containing utility values of choosing Yes under bid values is returned. When newdata = NULL and type = probability, a vector containing probabilities of choosing Yes is returned. When a new data is assigned to newdata, a vector containing utility values of choosing Yes (type = utility) or probability of choosing Yes (type = probability) under the new data is returned.

See Also

sbchoice

Examples

## See Examples in sbchoice.

DCchoice documentation built on July 26, 2023, 6:11 p.m.