gratia (version 0.9.0)

add_residuals.gam: Add residuals from a GAM to a data frame

Description

Add residuals from a GAM to a data frame

Usage

# S3 method for gam
add_residuals(data, model, value = ".residual", type = "deviance", ...)

Value

A data frame (tibble) formed from data and residuals from model.

Arguments

data

a data frame containing values for the variables used to fit the model. Passed to stats::predict() as newdata.

model

a fitted model for which a stats::predict() method is available. S3 method dispatch is performed on the model argument.

value

character; the name of the variable in which model predictions will be stored.

type

character; the type of residuals to return. See mgcv::residuals.gam() for options.

...

additional arguments passed to mgcv::residuals.gam().

Examples

load_mgcv()
# \dontshow{
op <- options(pillar.sigfig = 3, cli.unicode = FALSE)
# }
df <- data_sim("eg1", seed = 1)
df <- df[, c("y", "x0", "x1", "x2", "x3")]
m <- gam(y ~ s(x0) + s(x1) + s(x2) + s(x3), data = df, method = "REML")

##
add_residuals(df, m)
# \dontshow{
options(op)
# }