outFrames {CATALYST}R Documentation

Population-wise flowFrames from a dbFrame

Description

Returns a flowSet or list of flowFrames from a dbFrame. Each flowFrame will contain the subset of events that have been assigned to the same ID.

Usage

outFrames(x, ...)

## S4 method for signature 'dbFrame'
outFrames(x, return = "flowSet", which = "assigned")

Arguments

x

a dbFrame.

...

optional arguments.

return

"flowSet" or "list". Specifies the output type.

which

Specifies which barcode(s) to include. "assigned" (if the population of unassigned events should be excluded), "all" (if the latter should be included), or a numeric or character specifying a subset of populations. Valid values are IDs that occur as row names in the bc_key of the supplied dbFrame. Defaults to "assigned".

Details

Creates a separate flowFrame for each barcode population and, if desired, the population of unassigned events.

Value

a flowSet or list of flowFrames.

Author(s)

Helena Lucia Crowell helena.crowell@uzh.ch

Examples

data(sample_ff, sample_key)
re <- assignPrelim(x = sample_ff, y = sample_key)
re <- estCutoffs(x = re)
re <- applyCutoffs(x = re)
outFrames(x = re, return = "list", which = c("B1", "D4"))
[Package CATALYST version 1.10.3 Index]