R/is_gam_model.R

In insight: Easy Access to Model Information for Various Model Objects

#' @title Checks if a model is a generalized additive model
#' @name is_gam_model
#'
#' @description Small helper that checks if a model is a generalized additive
#' model.
#'
#' @param x A model object.
#'
#' @return A logical, `TRUE` if `x` is a generalized additive model
#' *and* has smooth-terms
#'
#' @note This function only returns `TRUE` when the model inherits from a
#' typical GAM model class *and* when smooth terms are present in the model
#' formula. If model has no smooth terms or is not from a typical gam class,
#' `FALSE` is returned.
#'
#' @examplesIf require("mgcv")
#' data(iris)
#' model1 <- lm(Petal.Length ~ Petal.Width + Sepal.Length, data = iris)
#' model2 <- mgcv::gam(Petal.Length ~ Petal.Width + s(Sepal.Length), data = iris)
#' is_gam_model(model1)
#' is_gam_model(model2)
#' @export
is_gam_model <- function(x) {
  inherits(.get_class_list(x), .get_gam_classes()) && !is.null(find_smooth(x, flatten = TRUE))
}