R/sw_glance.R

In business-science/sweep: Tidy Tools for Forecasting

#' Construct a single row summary "glance" of a model, fit, or other
#' object
#'
#'
#' @param x model or other R object to convert to single-row data frame
#' @param ... other arguments passed to methods
#'
#' @details
#' `sw_glance()` is a wrapper for `broom::glance()`. The benefit of `sw_glance`
#' is that it has methods for various time-series model classes such as
#' `HoltWinters`, `ets`, `Arima`, etc.
#' `sw_glance` methods always return either a one-row tibble or `NULL`.
#' The single row includes summary statistics relevent to the model accuracy,
#' which can be used to assess model fit and quality.
#'
#' For non-time series, `sw_glance()` defaults to `broom::glance()`.
#' The only difference is that the return is a tibble.
#'
#' @return single-row tibble with model summary information.
#'
#' @seealso [broom::glance()]
#'
#' @export
sw_glance <- function(x, ...) UseMethod("sw_glance")


#' Default glance method
#'
#' By default, `sw_glance()` uses [broom::glance()] to convert its output.
#'
#'
#' @param x an object to be tidied
#' @param ... extra arguments passed to `broom::glance()`
#'
#' @return A tibble generated by [broom::glance()]
#'
#' @export
sw_glance.default <- function(x, ...) {
    broom::glance(x, ...) %>%
        tibble::as_tibble()
}