Create range gate

Creates a range gate.

createRangeGate(
  experimentId,
  xChannel,
  name,
  x1,
  x2,
  y = 0.5,
  label = c(mean(c(x1, x2)), y),
  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 channel to which the gate applies.

name

The name of the gate.

x1

The first x coordinate (after the channel's scale has been applied).

x2

The second x coordinate (after the channel's scale has been applied).

y

Position of the horizontal line between the vertical lines, in the range 0 to 1.

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{
createRangeGate(experimentId, "FSC-A", "my gate", 12.502, 95.102)
} # }