Set FCS file panel — setFcsFilePanel • cellengine

Updates the panel properties of an FCS file.

setFcsFilePanel(experimentId, fcsFileId, panelName, panel)

Arguments

experimentId: ID of experiment.
fcsFileId: ID of FCS file.
panelName: Name of panel.
panel: List of channel properties.

Details

A panel must be specified as a list of lists. Each inner list must have at least channel and index properties, and may optionally have a reagent property.

The index value corresponds to the parameter index (i.e. the n in "$PnN" from the FCS file header). This property allows the list of channels to be in any order.

The channel value corresponds to the channel name. Channel names are used for matching channels between FCS files, gates, scales and compensations.

The reagent value is used for various displays, including plot axis labels, and is typically the reagent description (e.g. "CD3-PacBlu").

The panelName property is used to group files by panel.

Examples

if (FALSE) { # \dontrun{
panel <- list(
  list("index" = 1, "channel" = "FSC-A"),
  list("index" = 7, "channel" = "Blue530-A", "reagent" = "CD3")
)
setFcsFilePanel(experimentId, fcsFileId, "Panel 1", panel)
} # }