group_split

R/dplyr_methods.R

@@ -875,3 +875,49 @@ pull.SingleCellExperiment <- function(.data, var=-1, name=NULL, ...) {
         as_tibble() %>%
         dplyr::pull(var=!!var, name=!!name, ...)
 }
+
+#' @name group_split
+#' @rdname group_split
+#' @inherit dplyr::group_split
+#'
+#' @param .data 
+#'
+#' @return
+#' @export
+#'
+#' @examples
+#' data(pbmc_small)
+#' pbmc_small |> group_split(pbmc_small, groups)
+group_split.SingleCellExperiment <- function(.data, var) {
+
+
+    if(any(paste(substitute(var)) == names(colData(.data)))) {
+        var <- enquo(var)
+        var_list <- .data |> 
+            as_tibble() |> 
+            select(!!var) |> 
+            unlist(use.names = FALSE)
+
+        groups <- unique(var_list)
+
+        v <- vector(mode = "list", length = length(groups))
+
+        for (n in seq_along(groups)) {
+            v[[n]] <- .data[, var_list == groups[[n]]] 
+            }
+
+        return(v)
+    }
+
+    if(any(paste(substitute(var)) == names(rowData(.data)))) {
+      var <- enquo(var)
+        var_list <- .data |> 
+            rowData() |>
+            as_tibble() |> 
+            select(!!var) |> 
+            unlist(use.names = FALSE)
+
+        split(.data, var_list) |> 
+            as.list()
+    }
+}

tests/testthat/test-dplyr_methods.R

@@ -318,3 +318,18 @@ test_that("rowwise()", {
     expect_equal(dim(fd), c(ncol(df), 1))
     expect_identical(fd[[1]], sapply(df$lys, sum))
 })
+
+test_that("group_split()", {
+    fd <- df |> 
+    group_split("groups")
+    expect_equal(length(fd), length(unique(df$groups)))
+
+    fd <- df |> 
+    group_split("vst.variable")
+    expect_equal(length(fd), length(unique(rowData(df)$vst.variable)))
+
+    fd <- df |> 
+      group_split(vst.variable)
+    expect_equal(length(fd), length(unique(rowData(df)$vst.variable)))
+})
+