add dials methods for hier_clust

Author: EmilHvitfeldt

NAMESPACE

@@ -71,6 +71,7 @@ export(.k_means_fit_stats)
 export(augment)
 export(cluster_metric_set)
 export(control_cluster)
+export(cut_height)
 export(extract_centroids)
 export(extract_cluster_assignment)
 export(extract_fit_engine)
@@ -90,6 +91,7 @@ export(glance)
 export(hier_clust)
 export(k_means)
 export(knit_engine_docs)
+export(linkage_method)
 export(list_md_problems)
 export(load_pkgs)
 export(make_classes_tidyclust)
@@ -121,6 +123,7 @@ export(translate_tidyclust)
 export(translate_tidyclust.default)
 export(tune)
 export(tune_cluster)
+export(values_linkage_method)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,bind_cols)
 importFrom(generics,augment)

R/dials-params.R

@@ -0,0 +1,45 @@
+#' Cut Height
+#'
+#' Used in most `tidyclust::hier_clust()` models.
+#'
+#' @inheritParams dials::Laplace
+#' @examples
+#' cut_height()
+#' @export
+cut_height <- function(range = c(0, dials::unknown()), trans = NULL) {
+  dials::new_quant_param(
+    type = "integer",
+    range = range,
+    inclusive = c(TRUE, TRUE),
+    trans = trans,
+    label = c(cut_height = "Cut Height"),
+    finalize = NULL
+  )
+}
+
+#' The agglomeration Linkage method
+#'
+#' @param values A character string of possible values. See `linkage_methods`
+#'  in examples below.
+#'
+#' @details
+#' This parameter is used in `tidyclust` models for `hier_clust()`.
+#' @examples
+#' values_linkage_method
+#' linkage_method()
+#' @export
+linkage_method <- function(values = values_linkage_method) {
+  dials::new_qual_param(
+    type = "character",
+    values = values,
+    label = c(activation = "Linkage Method"),
+    finalize = NULL
+  )
+}
+
+#' @rdname linkage_method
+#' @export
+values_linkage_method <- c(
+  "ward.D", "ward.D2", "single", "complete", "average", "mcquitty", "median",
+  "centroid"
+)