setGate: setGate

Description Usage Arguments Details Value Author(s) See Also

View source: R/flowGate.R

Description

Apply a gate to a FlowHist object

Usage

1
2
3
setGate(fh, gate, refresh = TRUE)

isGated(fh)

Arguments

fh

a FlowHist object

gate

boolean, a vector indicating which rows in the raw data should be included (gated) in the analysis.

refresh

boolean, should the analysis be updated after applying the gate (default = TRUE)?

Details

This function is primarily book-keeping to make sure that histData and downstream calculations are appropriately updated when a gate is applied. The code for applying the gate is actually in the function setBins.

Value

setGate returns an updated FlowHist object, with the histData slot updated to account for the gate. With refresh = TRUE (default), it will also rebuild the model and complete the analysis.

isGated returns TRUE if the FlowHist object is gated.

Author(s)

Tyler Smith

See Also

setBins


Bioconductor-mirror/flowPloidy documentation built on June 1, 2017, 8:41 a.m.