R/param_num_clusters.R

In dials: Tools for Creating Tuning Parameter Values

#' Number of Clusters
#'
#' Used in most `tidyclust` models.
#'
#' @inheritParams Laplace
#' @examples
#' num_clusters()
#' @export
num_clusters <- function(range = c(1L, 10L), trans = NULL) {
  new_quant_param(
    type = "integer",
    range = range,
    inclusive = c(TRUE, TRUE),
    trans = trans,
    label = c(num_clusters = "# Clusters"),
    finalize = NULL
  )
}