Merge pull request #259 from tidymodels/num_clusters

add `num_clusters()` param

NAMESPACE

@@ -113,6 +113,7 @@ export(new_qual_param)
 export(new_quant_param)
 export(no_global_pruning)
 export(num_breaks)
+export(num_clusters)
 export(num_comp)
 export(num_hash)
 export(num_knots)

NEWS.md

@@ -13,6 +13,8 @@
 
 * The label for `spline_degree()` was improved. 
 
+* Added `num_clusters()` for tidyclust models.
+
 # dials 1.0.0
 
 * The new parameter `mtry_prop()` is a variation on `mtry()` where the value is

R/param_num_clusters.R

@@ -0,0 +1,18 @@
+#' 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
+  )
+}

_pkgdown.yml

@@ -68,6 +68,7 @@ reference:
     - mtry_prop
     - neighbors
     - num_breaks
+    - num_clusters
     - num_comp
     - num_hash
     - num_knots

tests/testthat/test-params.R

@@ -76,6 +76,7 @@ test_that("param ranges", {
   expect_equal(rate_steps(c(7L, 15L))$range, list(lower = 7L, upper = 15L))
   expect_equal(rate_step_size(c(7L, 15L))$range, list(lower = 7L, upper = 15L))
   expect_equal(rate_decay(c(1, 2))$range, list(lower = 1, upper = 2))
+  expect_equal(num_clusters(c(1, 2))$range, list(lower = 1, upper = 2))
 })