plot_gs: Plot a GatingSet

Description Usage Arguments Value

View source: R/flowR.R

Description

Plot a GatingSet

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
plot_gs(
  gs,
  df = NULL,
  sample = NULL,
  subset = NULL,
  spill = NULL,
  metadata = NULL,
  gate_name = NULL,
  Ncells = NULL,
  plot_type = "hexagonal",
  plot_args = list(),
  options = list()
)

Arguments

gs

a GatingSet

df

a data.frame with plot data resulting from a call of get_plot_data. Supersedes parameters 'gs', 'sample', 'spill', 'metadata'

sample

Names of samples from the GatingSet (as returned by pData(gs)$name)

subset

Names of subsets from the GatingSet (as returned by gs_get_pop_paths(gs))

spill

spillover matrix. If NULL, uncompensated data is used for gating and plotting.

metadata

a data.frame containing metadata associated to samples. Must have a column name used for mapping.

gate_name

Names of the gates to add to the plot (if it is compatible with plot parameters). Ignored if NULL.

Ncells

Maximum number of cells per sample and subset. If NULL, all cells are used.

plot_type

name of the plot type

plot_args

list of plot parameters passed to the plot function. Plot parameters depend on the plot type selected.

options

list of plot format options passed to format_plot()

Value

a plot


VoisinneG/flowR documentation built on June 1, 2021, 6:42 p.m.