Export populations to a new experiment

Exports populations and FCS files from an experiment into a new experiment.

exportPopulationsToNewExperiment(
  experimentId,
  compensationId,
  name = NULL,
  fcsFileIds = NULL,
  filenameTemplate = NULL,
  populationIds = NULL,
  preSubsampleN = NULL,
  postSubsampleN = NULL,
  preSubsampleP = NULL,
  postSubsampleP = NULL,
  seed = NULL,
  addEventNumber = FALSE
)

Arguments

experimentId

ID of the source experiment or a byName expression.

compensationId

ID of compensation, special compensation type (UNCOMPENSATED, FILE_INTERNAL PER_FILE) or a byName expression to use for gating. This should generally match what you used to create your gates.

name

Name of the new experiment.

fcsFileIds

FCS file IDs to export, as a character vector or list. List elements may be byName expressions, which are matched against FCS filenames. If omitted or empty, all non-control files are used.

filenameTemplate

Template for the names of the exported files.

populationIds

Population IDs to export, as a character vector or list. List elements may be byName expressions, which are matched against population names. If omitted, the ungated population is exported.

preSubsampleN

Number of events to subsample before gating.

postSubsampleN

Number of events to subsample after gating.

preSubsampleP

Fraction of events to subsample before gating.

postSubsampleP

Fraction of events to subsample after gating.

seed

Seed for deterministic subsampling.

addEventNumber

Whether to add an event number corresponding to the index in the source file.

Examples

if (FALSE) { # \dontrun{
exportPopulationsToNewExperiment(
  experimentId,
  compensationId,
  name = "Exported populations",
  populationIds = c("populationId1", "populationId2")
)
} # }