filter {scater} | R Documentation

## Return `SingleCellExperiment` with cells matching conditions.

### Description

Subsets the columns (cells) of a `SingleCellExperiment` based on matching conditions in the rows of `colData(object)`.

### Usage

    filter(object, ...)

    ## S4 method for signature 'SingleCellExperiment'
    filter(object, ...)

### Arguments

`object` | A `SingleCellExperiment` object.
`...` | Additional arguments to be passed to `dplyr::filter` to act on `colData(object)`.

### Value

An SingleCellExperiment object.

### Examples

    data("sc_example_counts")
    data("sc_example_cell_info")
    example_sce <- SingleCellExperiment(
    assays = list(counts = sc_example_counts),
    colData = sc_example_cell_info)
    example_sce_treat1 <- filter(example_sce, Treatment == "treat1")

[Package scater version 1.6.3 Index]