safe_predict.mlm: Safe predictions from a multiple linear model object

In alexpghayes/safepredict: Consistent prediction following tidymodels principles

Description

Safe predictions from a multiple linear model object

Usage

## S3 method for class 'mlm'
safe_predict(object, new_data, type = c("response"), ...)

Arguments

object	An mlm object returned from a call to stats::lm().
new_data	Required. A data frame or matrix containing the necessary predictors.
type	What kind of predictions to return. Options are: "response" (default): Standard predictions from multiple regression.
...	Unused. safe_predict() checks that all arguments in ... are evaluated via the ellipsis package. The idea is to prevent silent errors when arguments are mispelled. This feature is experimental and feedback is welcome.

Value

A tibble::tibble() with one row for each row of new_data. Predictions for observations with missing data will be NA. Returned tibble has different columns depending on type:

• "response":

  • univariate outcome: .pred (numeric)

  • multivariate outcomes: .pred_{outcome name} (numeric) for each outcome

• "class": .pred_class (factor)

• "prob": .pred_{level} columns (numerics between 0 and 1)

• "link": .pred (numeric)

• "conf_int": .pred, .pred_lower, .pred_upper (all numeric)

• "pred_int": .pred, .pred_lower, .pred_upper (all numeric)

If you request standard errors with std_error = TRUE, an additional column .std_error.

For interval predictions, the tibble has additional attributes level and interval. The level is the same as the level argument and is between 0 and 1. interval is either "confidence" or "prediction". Some models may also set a method attribute to detail the method used to calculate the intervals.

Estimating uncertainty

'stats::predict.mlm()“ provides neither confidence nor prediction intervals, although there is not theoretical issue with calculating these.

At some point in the future we may implement these intervals within safepredict. If you are interested in this, you can move intervals for mlm objects up the priority list by opening an issue on Github.

Examples

fit <- lm(cbind(hp, mpg) ~ ., mtcars)

safe_predict(fit, mtcars)

mt2 <- mtcars
diag(mt2) <- NA

safe_predict(fit, mt2)

alexpghayes/safepredict documentation built on May 29, 2019, 11:02 p.m.