add freq_itemsets tunable param

NAMESPACE

@@ -105,6 +105,7 @@ export(max_times)
 export(max_tokens)
 export(min_dist)
 export(min_n)
+export(min_support)
 export(min_times)
 export(min_unique)
 export(mixture)

R/param_min_support.R

@@ -0,0 +1,18 @@
+#' Parameter to control the minimum support value for frequent itemsets
+#'
+#' Used in all `tidyclust::freq_itemsets()` models.
+#'
+#' @inheritParams Laplace
+#' @examples
+#' min_support()
+#' @export
+min_support <- function(range = c(0.1, 0.5), trans = NULL) {
+  dials::new_quant_param(
+    type = "double",
+    range = range,
+    inclusive = c(TRUE, TRUE),
+    trans = trans,
+    label = c(min_support = "Minimum Support Value"),
+    finalize = NULL # Add to look at data and create a CI-like range around some min support value
+  )
+}

tests/testthat/test-params.R

@@ -142,6 +142,7 @@ test_that("param ranges", {
   expect_equal(num_tokens(c(31, 100))$range, list(lower = 31, upper = 100))
   expect_equal(mtry_prop(c(.1, .2))$range, list(lower = .1, upper = .2))
   expect_equal(dropout(c(.1, .2))$range, list(lower = .1, upper = .2))
+  expect_equal(min_support(c(.05, .5))$range, list(lower = .05, upper = .5))
 })