gratia (version 0.10.0)

model_constant: 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 gam
model_constant(model, lp = NULL, ...)
# S3 method for 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

# \dontshow{
op <- options(digits = 4)
# }
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]

# \dontshow{
options(op)
# }