cyto_plot_gate-polygonGate-method: Plot polygonGate Objects onto an Existing Plot

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

Description

Plot polygonGate Objects onto an Existing Plot

Usage

## S4 method for signature 'polygonGate'
cyto_plot_gate(x, channels, gate_line_type = 1,
  gate_line_width = 2.5, gate_line_col = "red", gate_point = FALSE,
  gate_point_shape = 16, gate_point_size = 1)

Arguments

x	an object of class polygonGate.
channels	fluorescent channels to used to construct the plot.
gate_line_type	integer [0,6] which controls the line type, set to 1 to draw solid lines by default.
gate_line_width	numeric to adjust line thickness of gates, set to 2.5 by default.
gate_line_col	indicates the colour of the gate to be constructed, set to "red" by default.
gate_point	logical indicating whether points should be included when plotting the gates, set to FALSE by default.
gate_point_shape	integer [0,25] passed to pch to control the shape of the points, set to 16 to draw filled circles by default. For other shapes refer to ?pch.
gate_point_size	numeric character expansion to control the size of the points in the drawn gate, set to 1 by default.

Value

gate object with modified co-ordinates for plotting.

Author(s)

Dillon Hammill, [e-mail]

See Also

cyto_plot_gate,rectangleGate-method

cyto_plot_gate,ellipsoidGate-method

cyto_plot_gate,list-method

cyto_plot_gate,filters-method

Examples

library(CytoRSuiteData)

# Load in samples
fs <- Activation
gs <- GatingSet(fs)

# Apply compensation
gs <- compensate(gs, fs[[1]]@description$SPILL)

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

# Gate using gate_draw
gating(Activation_gatingTemplate, gs)

# Plot
cyto_plot(gs[[4]],
  parent = "root",
  channels = c("FSC-A", "SSC-A")
)

# Cells gate
cyto_plot_gate(getGate(gs, "Cells")[[1]],
  channels = c("FSC-A", "SSC-A"),
  gate_line_col = "purple"
)

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