Create quadrant gate — createQuadrantGate • cellengine

Creates a quadrant gate. Quadrant gates have four sectors (upper-right, upper-left, lower-left, lower-right), each with a name and unique gid.

createQuadrantGate(
  experimentId,
  xChannel,
  yChannel,
  name,
  x,
  y,
  labels = NULL,
  gid = generateId(),
  gids = replicate(4, generateId()),
  parentPopulationId = NULL,
  tailoredPerFile = FALSE,
  fcsFileId = NULL,
  locked = FALSE,
  createPopulations = 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. Each sector is named with this parameter and a quadrant flag (UR, UL, LL, LR).
x: The x coordinate (after the channel's scale has been applied).
y: The y coordinate (after the channel's scale has been applied).
labels: Positions of the quadrant labels. A list of four length-2 vectors in the order: UR, UL, LL, LR. These are set automatically to the plot corners.
gid: Top-level group ID of the gate, used for tailoring. If this is not specified, then a new Group ID will be created. For compound gates, "gid" refers to the top-level GID. Each sector has a unique model gid and name to which populations must refer.
gids: Group IDs of each sector, assigned to model.gids.
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.
createPopulations: Automatically create corresponding populations. Specify parentPopulationId if set to TRUE. Because R performs partial matching of argument names, this can also be specified as createPopulation for consistency with the other create__Gate functions.

Examples

if (FALSE) { # \dontrun{
createQuadrantGate(experimentId, "FSC-A", "FSC-W", "my gate", 160000, 200000)
} # }