updateFcsFile: Update Fcs File

View source: R/updateFcsFile.R

updateFcsFileR Documentation

Update Fcs File

Description

Updates an fcs file

Usage

updateFcsFile(experimentId, fcsFileId, properties = list())

Arguments

experimentId

character ID of experiment.

fcsFileId

character ID of file or a byName expression.

properties

list Properties to set on the fcs file.

Accepted properties:

  • filename character The name of the file

  • panel list List with properties:

    • channel character

    • index character

    • reagent character Optional; only channel and index are required.

  • panelName character

  • isControl logical

  • compensation character Compensation ID

  • deleted string ISO 8601 date string, "%Y-%m-%dT%H:%M:%S.%fZ"

  • gatesLocked logical

  • annotations list List with properties:

    • name character

    • value character

Examples

## Not run: 
updateFcsFile(experimentId, list("filename" = "my fcs file"))

## End(Not run)

primitybio/cellengine-r-toolkit documentation built on Oct. 19, 2024, 1:17 a.m.