gate_draw-flowFrame-method: gate_draw flowFrame Method.

In DillonHammill/cytoSuite: Compensation, Gating & Visualisation Toolkit for Analysis of Flow Cytometry Data

Description

Manually draw gates around populations for analysis of flow cytometry data.

Usage

## S4 method for signature 'flowFrame'
gate_draw(x, channels = NULL, alias = NULL,
  type = "polygon", display = 1/length(x), axis = "x",
  density_smooth = 1.5, label = TRUE, plot = TRUE, ...)

Arguments

x	object of class flowFrame.
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.
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.
type	vector of gate type names used to construct the gates. Multiple gate types are supported but should be accompanied with an alias argument of the same length (i.e. one type per alias). Supported gate types include polygon, rectangle, ellipse, threshold, boundary, interval, quadrant and web which can be abbreviated as upper or lower case first letters as well. Default type is "interval" for 1D gates and "polygon" for 2D gates.
display	numeric [0,1] to control the percentage of events to be plotted. Specifying a value for display can substantial improve plotting speed for less powerful machines.
axis	indicates whether the "x" or "y" axis should be gated for 2-D interval gates.
density_smooth	smoothing factor passed to density for 1-D plots (defaults to 1.5).
label	logical indicating whether to include cyto_plot_label for the gated population(s), TRUE by default.
plot	logical indicating whether a plot should be drawn, set to TRUE by default.
...	additional arguments for cyto_plot,flowFrame-method.

Value

a filters list containing the drawn gate objects.

Author(s)

Dillon Hammill, [e-mail]

See Also

cyto_plot,flowFrame-method

gate_draw,flowSet-method

gate_draw,GatingSet-method

Examples

## Not run: 
library(CytoRSuiteData)

# Load in samples
fs <- Activation

# draw gates using gate_draw - add contour lines & overlay control
gt <- gate_draw(fs[[4]],
  channels = c("FSC-A", "SSC-A"),
  alias = "Cells",
  type = "ellipse",
  contour_lines = 15,
  overlay = fs[[1]]
)

# gt is a filters object containing the contructed ellipsoidGate
gt[[1]]

## End(Not run)

DillonHammill/cytoSuite documentation built on March 7, 2019, 10:09 a.m.