Fix: Allows roll_elements() to work on non-numeric vectors/columns

Author: LudvigOlsen

NEWS.md

@@ -1,4 +1,8 @@
 
+# rearrr 0.3.5.9000
+
+* Fix: `roll_elements()` now works on non-numeric vectors/columns.
+
 # rearrr 0.3.5
 
 * Replaces use of `dplyr::all_equal()` with `all.equal()`.

R/apply_coordinate_fn.R

@@ -13,11 +13,16 @@ apply_coordinate_fn_ <- function(dim_vectors,
                                  dim_var_name,
                                  grp_id,
                                  allow_len_one = FALSE,
+                                 allow_non_numerics = FALSE,
                                  extra_args = NULL) {
 
   # Check arguments ####
   assert_collection <- checkmate::makeAssertCollection()
-  checkmate::assert_list(dim_vectors, types = "numeric", any.missing = FALSE, min.len = 1, add = assert_collection)
+  if (isTRUE(allow_non_numerics)){
+    checkmate::assert_list(dim_vectors, any.missing = FALSE, min.len = 1, add = assert_collection)
+  } else {
+    checkmate::assert_list(dim_vectors, types = "numeric", any.missing = FALSE, min.len = 1, add = assert_collection)
+  }
   checkmate::assert_numeric(coordinates, any.missing = FALSE, null.ok = TRUE, min.len = 1, add = assert_collection)
   checkmate::assert_function(fn, null.ok = TRUE, add = assert_collection)
   checkmate::assert_number(num_dims, lower = 1, add = assert_collection)

R/roll_elements.R

@@ -231,6 +231,7 @@ roll_elements_rearranger_method_ <- function(data,
     dim_var_name = "cols",
     grp_id = grp_id,
     allow_len_one = TRUE,
+    allow_non_numerics = TRUE,
     extra_args = n_fn_args
   )
 

tests/testthat/test_roll_elements.R

@@ -1216,3 +1216,165 @@ test_that("fuzz testing roll_elements()", {
 
 
 })
+
+test_that("prev error cases in roll_elements()", {
+
+
+  ## Testing 'roll_elements(as.character(1:10), n = 2)'                     ####
+  ## Initially generated by xpectr
+  xpectr::set_test_seed(42)
+  # Assigning output
+  output_19148 <- roll_elements(as.character(1:10), n = 2)
+  # Testing class
+  expect_equal(
+    class(output_19148),
+    c("tbl_df", "tbl", "data.frame"),
+    fixed = TRUE)
+  # Testing column values
+  expect_equal(
+    output_19148[["Value"]],
+    c("3", "4", "5", "6", "7", "8", "9", "10", "1", "2"),
+    fixed = TRUE)
+  # Testing column names
+  expect_equal(
+    names(output_19148),
+    c("Value", ".n"),
+    fixed = TRUE)
+  # Testing column classes
+  expect_equal(
+    xpectr::element_classes(output_19148),
+    c("character", "list"),
+    fixed = TRUE)
+  # Testing column types
+  expect_equal(
+    xpectr::element_types(output_19148),
+    c("character", "list"),
+    fixed = TRUE)
+  # Testing dimensions
+  expect_equal(
+    dim(output_19148),
+    c(10L, 2L))
+  # Testing group keys
+  expect_equal(
+    colnames(dplyr::group_keys(output_19148)),
+    character(0),
+    fixed = TRUE)
+  ## Finished testing 'roll_elements(as.character(1:10), n = 2)'            ####
+
+  # Set seed
+  xpectr::set_test_seed(42)
+
+  df <- data.frame(
+    "x" = as.character(1:20),
+    "y" = 1:20,
+    "g" = rep(1:4, each = 5),
+    stringsAsFactors = FALSE
+  )
+
+
+  ## Testing 'roll_elements(df, n = 1, cols = "x")'                         ####
+  ## Initially generated by xpectr
+  xpectr::set_test_seed(42)
+  # Assigning output
+  output_19148 <- roll_elements(df, n = 1, cols = "x")
+  # Testing class
+  expect_equal(
+    class(output_19148),
+    c("tbl_df", "tbl", "data.frame"),
+    fixed = TRUE)
+  # Testing column values
+  expect_equal(
+    output_19148[["y"]],
+    c(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
+      19, 20),
+    tolerance = 1e-4)
+  expect_equal(
+    output_19148[["g"]],
+    c(1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4),
+    tolerance = 1e-4)
+  expect_equal(
+    output_19148[["x"]],
+    c("2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13",
+      "14", "15", "16", "17", "18", "19", "20", "1"),
+    fixed = TRUE)
+  # Testing column names
+  expect_equal(
+    names(output_19148),
+    c("y", "g", "x", ".n"),
+    fixed = TRUE)
+  # Testing column classes
+  expect_equal(
+    xpectr::element_classes(output_19148),
+    c("integer", "integer", "character", "list"),
+    fixed = TRUE)
+  # Testing column types
+  expect_equal(
+    xpectr::element_types(output_19148),
+    c("integer", "integer", "character", "list"),
+    fixed = TRUE)
+  # Testing dimensions
+  expect_equal(
+    dim(output_19148),
+    c(20L, 4L))
+  # Testing group keys
+  expect_equal(
+    colnames(dplyr::group_keys(output_19148)),
+    character(0),
+    fixed = TRUE)
+  ## Finished testing 'roll_elements(df, n = 1, cols = "x")'                ####
+
+
+
+  ## Testing 'roll_elements(dplyr::group_by(df, g), n = 1,...'              ####
+  ## Initially generated by xpectr
+  xpectr::set_test_seed(42)
+  # Assigning output
+  output_19148 <- roll_elements(dplyr::group_by(df, g), n = 1, cols = "x")
+  # Testing class
+  expect_equal(
+    class(output_19148),
+    c("tbl_df", "tbl", "data.frame"),
+    fixed = TRUE)
+  # Testing column values
+  expect_equal(
+    output_19148[["y"]],
+    c(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
+      19, 20),
+    tolerance = 1e-4)
+  expect_equal(
+    output_19148[["g"]],
+    c(1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4),
+    tolerance = 1e-4)
+  expect_equal(
+    output_19148[["x"]],
+    c("2", "3", "4", "5", "1", "7", "8", "9", "10", "6", "12", "13",
+      "14", "15", "11", "17", "18", "19", "20", "16"),
+    fixed = TRUE)
+  # Testing column names
+  expect_equal(
+    names(output_19148),
+    c("y", "g", "x", ".n"),
+    fixed = TRUE)
+  # Testing column classes
+  expect_equal(
+    xpectr::element_classes(output_19148),
+    c("integer", "integer", "character", "list"),
+    fixed = TRUE)
+  # Testing column types
+  expect_equal(
+    xpectr::element_types(output_19148),
+    c("integer", "integer", "character", "list"),
+    fixed = TRUE)
+  # Testing dimensions
+  expect_equal(
+    dim(output_19148),
+    c(20L, 4L))
+  # Testing group keys
+  expect_equal(
+    colnames(dplyr::group_keys(output_19148)),
+    character(0),
+    fixed = TRUE)
+  ## Finished testing 'roll_elements(dplyr::group_by(df, g), n = 1,...'     ####
+
+
+})