R/finalize.R

In tidyclust: A Common API to Clustering

# https://github.com/tidymodels/tune/blob/main/R/finalize.R

#' Splice final parameters into objects
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' These functions are deprecated. Please use [tune::finalize_model()] and
#' [tune::finalize_workflow()] instead, which now support `cluster_spec`
#' objects natively.
#'
#' @param x A recipe, `parsnip` model specification, or workflow.
#' @param parameters A list or 1-row tibble of parameter values. Note that the
#'   column names of the tibble should be the `id` fields attached to `tune()`.
#'   For example, in the `Examples` section below, the model has `tune("K")`. In
#'   this case, the parameter tibble should be "K" and not "neighbors".
#' @return An updated version of `x`.
#' @examples
#' kmeans_spec <- k_means(num_clusters = tune())
#' best_params <- data.frame(num_clusters = 5)
#'
#' # Old:
#' finalize_model_tidyclust(kmeans_spec, best_params)
#'
#' # New:
#' tune::finalize_model(kmeans_spec, best_params)
#' @export
finalize_model_tidyclust <- function(x, parameters) {
  lifecycle::deprecate_warn(
    "0.3.0",
    "finalize_model_tidyclust()",
    "tune::finalize_model()"
  )
  if (!inherits(x, "cluster_spec")) {
    cli::cli_abort("{.arg x} should be a tidyclust model specification.")
  }
  parsnip::check_final_param(parameters)
  pset <- hardhat::extract_parameter_set_dials(x)
  if (tibble::is_tibble(parameters)) {
    parameters <- as.list(parameters)
  }

  parameters <- parameters[names(parameters) %in% pset$id]

  discordant <- dplyr::filter(pset, id != name & id %in% names(parameters))
  if (nrow(discordant) > 0) {
    for (i in seq_len(nrow(discordant))) {
      names(parameters)[names(parameters) == discordant$id[i]] <-
        discordant$name[i]
    }
  }
  rlang::exec(stats::update, object = x, !!!parameters)
}

#' @rdname finalize_model_tidyclust
#' @export
finalize_workflow_tidyclust <- function(x, parameters) {
  lifecycle::deprecate_warn(
    "0.3.0",
    "finalize_workflow_tidyclust()",
    "tune::finalize_workflow()"
  )
  if (!inherits(x, "workflow")) {
    cli::cli_abort("{.arg x} should be {.obj_type_friendly workflow}")
  }
  parsnip::check_final_param(parameters)

  mod <- extract_spec_parsnip(x)
  mod <- finalize_model_tidyclust(mod, parameters)
  x <- tune::.set_workflow_spec(x, mod)

  if (tune::.has_preprocessor_recipe(x)) {
    rec <- extract_preprocessor(x)
    rec <- tune::finalize_recipe(rec, parameters)
    x <- tune::.set_workflow_recipe(x, rec)
  }

  x
}