Plot difference smooth from a GAM. — plot

It plots the difference smooth from a gam or bam. Significant differences are marked with red areas.

plot_difference(
  model,
  series,
  difference,
  conditions = NULL,
  exclude_random = TRUE,
  series_length = 100,
  ci_z = 1.96,
  time_series
)

Arguments

model	A `gam` or `bam` model object.
series	An unquoted expression indicating the model term that defines the series on which smoothing is applied. This is the term that is displayed on the x-axis when plotting.
difference	A named list with the levels to compute the difference of.
conditions	A named list specifying the levels to plot from the model terms not among `series` or `difference`. Notice the difference with plot_smooths, which uses `quos`.
exclude_random	Whether to exclude random smooths (the default is `TRUE`).
series_length	An integer indicating how many values along the time series to use for predicting the outcome term.
ci_z	The z-value for calculating the CIs (the default is `1.96` for 95 percent CI).
time_series	Deprecated, use `series` instead.

Value

A ggplot object.

Examples

library(mgcv)
set.seed(10)
data <- gamSim(4)
#> Factor `by' variable example
model <- gam(y ~ fac + s(x2) + s(x2, by = fac) + s(x0), data = data)

plot_difference(model, x2, list(fac = c("1", "2")))

# For details, see vignette
if (FALSE) {
vignette("plot-smooths", package = "tidymv")
}