gate_ellipse_draw constructs an interactive plotting window for user to select the limits of a population in 2 dimensions (4 points) which is constructed into ellipsoidGate object and stored in a filters list.

gate_ellipse_draw(fr, alias = NULL, channels, plot = TRUE,
  label = TRUE, ...)

Arguments

fr

a flowFrame object containing the flow cytometry data for plotting and gating.

alias

the name(s) of the populations to be gated. If multiple population names are supplied (e.g. c("CD3","CD4")) multiple gates will be returned. alias is NULL by default which will halt the gating routine.

channels

vector of channel names to use for plotting, can be of length 1 for 1-D density histogram or length 2 for 2-D scatter plot.

plot

logical indicating whether the data should be plotted. This feature allows for constructing gates of different types over existing plots which may already contain a different gate type.

label

logical indicating whether to include cyto_plot_label for the gated population(s), TRUE by default.

...

additional arguments for cyto_plot,flowFrame-method.

Value

afilters list containing the constructed ellipsoidGate object(s).

See also

Examples

# NOT RUN {
# Copy and paste into console to interactively draw gates

library(CytoRSuiteData)

# Load in samples to flowSet
fs <- Activation

# Transform fluorescent channels
fs <- transform(fs, estimateLogicle(fs[[4]], cyto_fluor_channels(fs)))

# Get ellipsoidGate using gate_ellipse_draw
eg <- gate_ellipse_draw(fs[[4]],
  alias = "Cells",
  channels = c("PE-A", "Alexa Fluor 700-A"),
  overlay = fs[[1]]
)

# eg is a filters object - extract ellipsoidGate using `[[`
eg[[1]]
# }