droplet_data: Return the droplet data from an SCE object

View source: R/objects.R

droplet_dataR Documentation

Return the droplet data from an SCE object

Description

Return droplet data. This contains data such as number of counts and genes in each droplet, as well as some of the output from the filtering, such as whether the droplet is classified as debris or cell/nucleus. The parameter min_counts filters out droplets (rows) by removing those with counts below this number. By default, returns all droplets in the test set. To return clean droplets, set the type parameter to 'clean', to return debris droplets in the test set, set to 'debris', and to return all droplets in the data set, set to 'all'.

Usage

droplet_data(x, min_counts = 1, type = "test")

Arguments

x

An SCE object.

min_counts

Minimum number of read counts a droplet must have to be output.

type

One of either 'test' (default), 'clean', 'debris', or 'all'. specifying how to subset the data frame to include only those droplets. The droplets in 'clean' and 'debris' make up the droplets in 'test'. If 'all', returns all droplets.

Value

A data frame


marcalva/diem documentation built on Jan. 1, 2023, 2:33 a.m.