recompute: Compute the cell events by the gates stored within the gating...

In RGLab/flowWorkspace: Infrastructure for representing and interacting with gated and ungated cytometry data sets.

Compute the cell events by the gates stored within the gating tree.

Description

Compute each cell event to see if it falls into the gate stored within the gating tree and store the result as cell count.

Usage

recompute(
  x,
  y = "root",
  alwaysLoadData = FALSE,
  verbose = FALSE,
  leaf.bool = TRUE
)

## S3 method for class 'GatingSet'
recompute(
  x,
  y = "root",
  alwaysLoadData = FALSE,
  verbose = FALSE,
  leaf.bool = TRUE
)

## S3 method for class 'GatingSetList'
recompute(x, ...)

Arguments

x	GatingSet or GatingSetList
y	character node name or node path. Default "root". Optional.
alwaysLoadData	logical. Specifies whether to load the flow raw data for gating boolean gates. Default 'FALSE'. Optional. Sometime it is more efficient to skip loading the raw data if all the reference nodes and parent are already gated. 'FALSE' will check the parent node and reference to determine whether to load the data. This check may not be sufficient since the further upstream ancestor nodes may not be gated yet. In that case, we allow the gating to fail and prompt user to recompute those nodes explictily. When TRUE, then it forces data to be loaded to guarantee the gating process to be uninterrupted at the cost of unnecessary data IO.
verbose	default is FALSE
leaf.bool	whether to compute the leaf boolean gate, default is TRUE
...	arguments

Details

It is usually used immediately after add or gs_pop_set_gate calls.

RGLab/flowWorkspace documentation built on March 17, 2024, 2:24 p.m.