made setspp redundant but backwards compatible with a warning

Author: sagebiej

R/simulate_choices.R

@@ -30,7 +30,17 @@
 #' )
 #' simulate_choices(example_df, ut, setspp = 4, bcoeff = beta)
 #'
-simulate_choices <- function(data, utility, setspp=NULL, bcoeff, decisiongroups = c(0, 1), manipulations = list(),  preprocess_function = NULL) { # the part in dataset that needs to be repeated in each run
+simulate_choices <- function(data, utility, setspp, bcoeff, decisiongroups = c(0, 1), manipulations = list(),  preprocess_function = NULL) { # the part in dataset that needs to be repeated in each run
+
+
+
+  if (!missing(setspp)) {
+    warning(
+      "`setspp` is deprecated and ignored. ",
+      "The number of choice sets per respondent is inferred from `data`.",
+      call. = FALSE
+    )
+  }
 
   if (!is.null(preprocess_function)) {
     if (!is.function(preprocess_function)) {

man/simulate_choices.Rd

@@ -39,6 +39,18 @@ formattedes <- readdesign(design = design, designtype = "spdesign")
 data <- simulateDCE::createDataset(formattedes, respondents = resps)
 
 
+test_that("simulate_choices() warns when deprecated setspp is used", {
+  expect_warning(
+    simulate_choices(
+      data   = data,
+      utility = ul,
+      setspp = 4,
+      bcoeff = bcoeff
+    ),
+    regexp = "is deprecated and ignored"
+  )
+})
+
 test_that("simulate_choices() does not error", {
   expect_error(
     simulate_choices(data = data, bcoeff = bcoeff, u = ul),