model_constant: Extract the model constant term

In gratia: Graceful 'ggplot'-Based Graphics and Other Functions for GAMs Fitted Using 'mgcv'

Extract the model constant term

Description

Extracts the model constant term(s), the model intercept, from a fitted model object.

Usage

model_constant(model, ...)

## S3 method for class 'gam'
model_constant(model, lp = NULL, ...)

## S3 method for class 'gamlss'
model_constant(model, ...)

Arguments

model	a fitted model for which a coef() method exists.
...	arguments passed to other methods.
lp	numeric; which linear predictors to extract constant terms for.

Examples

load_mgcv()

# simulate a small example
df <- data_sim("eg1", seed = 42)

# fit the GAM
m <- gam(y ~ s(x0) + s(x1) + s(x2) + s(x3), data = df, method = "REML")

# extract the estimate of the constant term
model_constant(m)
# same as coef(m)[1L]
coef(m)[1L]

gratia documentation built on April 3, 2025, 11:42 p.m.