Create FCS file — createFcsFile • cellengine

Creates an FCS file by copying, concatenating and/or subsampling existing files, or by importing a file from an S3-compatible service.

createFcsFile(
  experimentId,
  fcsFiles,
  addFileNumber = NULL,
  addEventNumber = NULL,
  filename = NULL,
  monotonicChannels = NULL,
  preSubsampleN = NULL,
  preSubsampleP = NULL,
  seed = NULL
)

Arguments

experimentId: ID of the experiment to which to add the file.
fcsFiles: A character vector of FCS file IDs, or a list of source objects. Source objects may specify _id and experimentId to copy a file from another experiment, or host and path to import a file from an S3-compatible service.
addFileNumber: If concatenating files, whether to add a file number channel.
addEventNumber: Whether to add an event number column.
filename: Filename to use for the created file. Required when concatenating or subsampling.
monotonicChannels: Channels whose values should remain monotonically increasing when concatenating files.
preSubsampleN: Randomly subsample each input file to this number of events before concatenating.
preSubsampleP: Randomly subsample each input file to this fraction of events before concatenating.
seed: Seed for deterministic subsampling.

Examples

if (FALSE) { # \dontrun{
createFcsFile(experimentId, c("fcsFileId1", "fcsFileId2"),
              filename = "combined.fcs")
} # }