Creates a split gate. split gates have two sectors (right and left), each with a name and unique gid.

createSplitGate(
  experimentId,
  xChannel,
  name,
  x,
  y = 0.5,
  gid = generateId(),
  gids = replicate(2, generateId()),
  labels = NULL,
  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.

name

The name of the gate. Each sector is named with this parameter and a split flag (L, R).

x

The x coordinate of the center point (after the channel's scale has been applied).

y

The y position of the dashed line extending from the center point (as a fraction of the height).

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.

labels

Positions of the quadrant labels. A list of two length-2 vectors in the order: L, R. These are set automatically to the top corners.

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{
createSplitGate(experimentId, "FSC-A", "my gate", 144000, 100000)
} # }