R/tidy_importance.R

In waywiser: Ergonomic Methods for Assessing Spatial Models

#' Convert various "importance" tibbles into standardized input formats
#'
#' @param importance Either a data.frame with columns "term" and "estimate", or
#' a `vi` object from the `vip` package.
#' @inheritParams rlang::args_dots_empty
#'
#' @return A data.frame with two columns, `term` and `estimate`.
#'
#' @noRd
tidy_importance <- function(importance, ...) {
  UseMethod("tidy_importance")
}

#' @noRd
tidy_importance.vi <- function(importance, ...) {
  rlang::check_dots_empty()
  data.frame(
    term = importance[["Variable"]],
    estimate = importance[["Importance"]]
  )
}

#' @noRd
tidy_importance.data.frame <- function(importance, ...) {
  rlang::check_dots_empty()
  if (!all(c("term", "estimate") %in% names(importance))) {
    rlang::abort(
      "'term' and 'estimate' must be columns in `importance`",
      call = rlang::caller_env()
    )
  }
  importance
}

#' @noRd
tidy_importance.default <- function(importance, ...) {
  cls <- class(importance)[1]
  rlang::abort(
    glue::glue("Can't construct a tidy importance table from an object of class {cls}")
  )
}