R/condense_control.R

In parsnip: A Common API to Modeling and Analysis Functions

#' Condense control object into strictly smaller control object
#'
#' This function is used to help the hierarchy of control functions used
#' throughout the tidymodels packages. It is now assumed that each control
#' function is either a subset or a superset of another control function.
#'
#' @param x A control object to be condensed.
#' @param ref A control object that is used to determine what element should be
#'   kept.
#'
#' @return A control object with the same elements and classes of `ref`, with
#'   values of `x`.
#' @param call The execution environment of a currently running function, e.g.
#'   `caller_env()`. The function will be mentioned in error messages as the
#'   source of the error. See the call argument of [rlang::abort()] for more
#'   information.
#' @keywords internal
#' @export
#'
#' @examplesIf !parsnip:::is_cran_check()
#' ctrl <- control_parsnip(catch = TRUE)
#' ctrl$allow_par <- TRUE
#' str(ctrl)
#'
#' ctrl <- condense_control(ctrl, control_parsnip())
#' str(ctrl)
condense_control <- function(x, ref, ..., call = rlang::caller_env()) {
  check_dots_empty()
  mismatch <- setdiff(names(ref), names(x))
  if (length(mismatch)) {
    cli::cli_abort(
      c(
        "{.obj_type_friendly {x}} cannot be coerced to {.obj_type_friendly {ref}}.",
        "i" = "{cli::qty(mismatch)} The argument{?s} {.arg {mismatch}}
               {?is/are} missing."
      ),
      call = call
    )
  }
  res <- x[names(ref)]
  class(res) <- class(ref)
  res
}