R/labels.R

In spmodel: Spatial Statistical Modeling and Prediction

#' Find labels from object
#'
#' @description Find a suitable set of labels from a fitted model object.
#'
#' @param object A fitted model object from [splm()], [spautor()], [spglm()], or [spgautor()].
#' @param ... Other arguments. Not used (needed for generic consistency).
#'
#' @return A character vector containing the terms used for the fixed effects
#'   from a fitted model object.
#'
#' @name labels.spmodel
#' @method labels splm
#' @order 1
#' @export
#'
#' @examples
#' spmod <- splm(z ~ water + tarp,
#'   data = caribou,
#'   spcov_type = "exponential", xcoord = x, ycoord = y
#' )
#' labels(spmod)
labels.splm <- function(object, ...) {
  # delegates to base R's formula/terms machinery, so this returns the fixed
  # effect term labels only (not spatial covariance or random effect terms)
  labels(terms(formula(object)))
}

#' @rdname labels.spmodel
#' @method labels spautor
#' @order 2
#' @export
labels.spautor <- labels.splm