Fix scenario list (#249)

* changing asplit to split

* Updating news

* Updating scenario_list

Author: kgoldfeld

NEWS.md

@@ -1,5 +1,11 @@
 # simstudy (development version)
 
+* scenario_list() return type change: now returns a list of 1-row 
+data.frames (instead of vectors) to support mixed numeric/character 
+scenario values without coercion. If you were transposing scenario 
+vectors for logging (e.g., data.table(t(argsvec), result)), 
+switch to data.table(argsvec, result). Vignettes updated.
+
 # simstudy (0.9.2)
 
 * A minor fix in a unit test for correlated matrices that was failing on CRAN due to

R/utility.R

@@ -53,8 +53,8 @@ grouped <- function(...) {
 #' vectors or `grouped_params` objects created with \code{\link{grouped}}.
 #' @param each Integer representing the number of replications for each scenario
 #' or set of parameters. Defaults to 1.
-#' @return A list of scenarios, where each element is a named vector of parameter 
-#' values with an added element `scenario` giving the scenario index.
+#' @return A list of scenarios, where each element is a one-row data.frame 
+#' of parameter values with an added element `scenario` giving the scenario index.
 #' @examples
 #' # Regular parameters
 #' s1 <- scenario_list(a = 1:2, b = c("x", "y"))
@@ -139,9 +139,10 @@ scenario_list <- function(..., each = 1) {
   }
 
   argmat$scenario <- seq_len(nrow(argmat))
-  scenarios <- asplit(argmat, MARGIN = 1)
-  
+  scenarios <- split(x = argmat, f = seq_len(nrow(argmat)))
+  names(scenarios) <- NULL
   return(rep(scenarios, each = each))
+  
 }
 
 #' Generate Mixture Formula

man/scenario_list.Rd

@@ -1516,14 +1516,14 @@ test_that("scenario_list() preserves correct values in scenarios", {
   result <- scenario_list(a, grouped(x, y))
 
   # Check first scenario
-  expect_equal(unname(result[[1]][1]), 1)
-  expect_equal(unname(result[[1]][2]), 10)
-  expect_equal(unname(result[[1]][[3]]), 100)
+  expect_equal(result[[1]][1, 1], 1)
+  expect_equal(result[[1]][1, 2], 10)
+  expect_equal(result[[1]][[1, 3]], 100)
 
   # Check last scenario
-  expect_equal(unname(result[[4]][1]), 2)
-  expect_equal(unname(result[[4]][2]), 20)
-  expect_equal(unname(result[[4]][[3]]), 200)
+  expect_equal(result[[4]][1, 1], 2)
+  expect_equal(result[[4]][1, 2], 20)
+  expect_equal(result[[4]][1, 3], 200)
 })
 
 test_that("scenario_list() assigns sequential scenario numbers", {
@@ -1533,16 +1533,17 @@ test_that("scenario_list() assigns sequential scenario numbers", {
   result <- scenario_list(a, b)
 
   scenarios <- sapply(result, function(x) x["scenario"])
-  expect_equal(unname(scenarios), 1:6)
+  expect_equal(unname(unlist(scenarios)), seq(1:6))
+  
 })
 
-test_that("scenario_list() returns list of named vectors", {
+test_that("scenario_list() returns list of data.frames", {
   a <- c(1, 2)
 
   result <- scenario_list(a)
 
   expect_type(result, "list")
-  expect_named(result[[1]], c("a", "scenario"))
+  expect_s3_class(result[[1]], "data.frame")
 })
 
 
@@ -1552,8 +1553,8 @@ test_that("scenario_list() handles edge case of single value", {
   result <- scenario_list(a)
 
   expect_equal(length(result), 1)
-  expect_equal(unname(result[[1]]["a"]), 1)
-  expect_equal(unname(result[[1]]["scenario"]), 1)
+  expect_equal(result[[1]][["a"]], 1)
+  expect_equal(result[[1]][["scenario"]], 1)
 })
 
 test_that("scenario_list() preserves variable names correctly when specified in call", {

tests/testthat/test-utility.R

@@ -185,7 +185,7 @@ Once the data have been collected, it is quite easy to summarize and create a ta
 
 ```{r, eval = FALSE}
 summarize <- function(m_fit) {
-  args <- data.table(t(m_fit[[1]]))
+  args <- data.table(m_fit[[1]])
   reject <- m_fit[[2]][term == "rx", p.value <= 0.05]
   cbind(args, reject)
 }