cyto_plot_gate: Plot Gate Objects onto an Existing cyto_plot

In DillonHammill/CytoExploreR: Interactive Analysis of Cytometry Data

Plot Gate Objects onto an Existing cyto_plot

Description

Plot Gate Objects onto an Existing cyto_plot

Usage

## Default S3 method:
cyto_plot_gate(gate, ...)

## S3 method for class 'rectangleGate'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

## S3 method for class 'polygonGate'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

## S3 method for class 'ellipsoidGate'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

## S3 method for class 'quadGate'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

## S3 method for class 'filters'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

## S3 method for class 'list'
cyto_plot_gate(
  gate,
  channels = NULL,
  gate_line_type = 1,
  gate_line_width = 2.5,
  gate_line_col = "red",
  gate_fill = "white",
  gate_fill_alpha = 0,
  ...
)

Arguments

gate	gate object of class rectangleGate, polygonGate, ellipsoidGate, list or filters.
...	not in use.
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_fill	fill colour(s) to use for gates, set to "white" by default.
gate_fill_alpha	numeric [0,1] to control gate fill colour transparency, set to 0 by default to make gate fill colour completely transparent.

Value

invisibly return modified gate objects with dimensions appropriate for the constructed plot.

Author(s)

Dillon Hammill, [e-mail]

DillonHammill/CytoExploreR documentation built on March 2, 2023, 7:34 a.m.