group_split: Split data frame by groups

In stemangiola/tidySingleCellExperiment: Brings SingleCellExperiment to the Tidyverse

Split data frame by groups

Description

group_split() works like base::split() but:

• It uses the grouping structure from group_by() and therefore is subject to the data mask

• It does not name the elements of the list based on the grouping as this only works well for a single character grouping variable. Instead, use group_keys() to access a data frame that defines the groups.

group_split() is primarily designed to work with grouped data frames. You can pass ... to group and split an ungrouped data frame, but this is generally not very useful as you want have easy access to the group metadata.

Usage

## S3 method for class 'SingleCellExperiment'
group_split(.tbl, ..., .keep = TRUE)

Arguments

.tbl	A tbl.
...	If .tbl is an ungrouped data frame, a grouping specification, forwarded to group_by().
.keep	Should the grouping columns be kept?

Value

A list of tibbles. Each tibble contains the rows of .tbl for the associated group and all the columns, including the grouping variables. Note that this returns a list_of which is slightly stricter than a simple list but is useful for representing lists where every element has the same type.

Lifecycle

group_split() is not stable because you can achieve very similar results by manipulating the nested column returned from tidyr::nest(.by =). That also retains the group keys all within a single data structure. group_split() may be deprecated in the future.

See Also

Other grouping functions: group_by(), group_map(), group_nest(), group_trim()

Examples

data(pbmc_small)
pbmc_small |> group_split(groups)

stemangiola/tidySingleCellExperiment documentation built on Sept. 24, 2024, 3:47 p.m.