gratia (version 0.9.0)

smooth_coefs: Coefficients for a particular smooth

Description

Returns a vector of model coefficients of the parametric terms that represent the supplied smooth.

Usage

smooth_coefs(object, ...)
# S3 method for gam
smooth_coefs(object, select, term = deprecated(), ...)
# S3 method for bam
smooth_coefs(object, select, term = deprecated(), ...)
# S3 method for gamm
smooth_coefs(object, select, term = deprecated(), ...)
# S3 method for gamm4
smooth_coefs(object, select, term = deprecated(), ...)
# S3 method for list
smooth_coefs(object, select, term = deprecated(), ...)
# S3 method for mgcv.smooth
smooth_coefs(object, model, ...)
# S3 method for scam
smooth_coefs(object, select, term = deprecated(), ...)

Value

A numeric vector of model coefficients.

Arguments

object

a fitted GAM(M) object, or, for the "mgcv.smooth" method, an object that inherits from class mgcv.smooth.

...

arguments passed to other methods.

select

character; the label of the smooth whose coefficients will be returned.

term

Use select instead.

model

a fitted GAM(M) object.

Author

Gavin L. Simpson

See Also

smooth_coef_indices() for extracting the indices of the coefficients for a particular smooth.

Examples

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

## IGNORE_RDIFF_BEGIN
smooth_coefs(m, select = "s(x2)")
## IGNORE_RDIFF_END
# \dontshow{
options(op)
# }