Create polygon gate — createPolygonGate • cellengine

Creates a polygon gate.

createPolygonGate(
  experimentId,
  xChannel,
  yChannel,
  name,
  vertices,
  label = NULL,
  gid = generateId(),
  parentPopulationId = NULL,
  tailoredPerFile = FALSE,
  fcsFileId = NULL,
  locked = FALSE,
  createPopulation = is.null(fcsFileId)
)

Arguments

experimentId: The ID of the experiment to which to add the gate, or a byName expression.
xChannel: The name of the x channel to which the gate applies.
yChannel: The name of the y channel to which the gate applies.
name: The name of the gate.
vertices: List of vectors of coordinates, like list(c(x,y), c(x,y), ...).
label: Position of the label. Defaults to the midpoint of the gate.
gid: Group ID of the gate, used for tailoring. If this is not specified, then a new Group ID will be created.
parentPopulationId: ID of the parent population or a byName expression. Use UNGATED for the "ungated" population. Only used if createPopulation is TRUE.
tailoredPerFile: Whether or not this gate is tailored per FCS file.
fcsFileId: ID of FCS file or a byName expression, if tailored per file. Use NULL for the global gate in a tailored gate group.
locked: Prevents modification of the gate via the web interface.
createPopulation: Automatically create corresponding population. Specify parentPopulationId if set to TRUE.

Examples

if (FALSE) { # \dontrun{
createPolygonGate(experimentId, "FSC-A", "FSC-W", "my gate", list(c(1, 2), c(4, 5), c(7, 8)))
} # }