ExportToFCS: FCS File Writer

In gitdemont/IFC: Tools for Imaging Flow Cytometry

FCS File Writer

Description

Writes an 'IFC_data' object to a Flow Cytometry Standard (FCS) file.

Usage

ExportToFCS(
  obj,
  write_to,
  overwrite = FALSE,
  delimiter = "/",
  cytometer = "Image Stream",
  ...
)

Arguments

obj	an 'IFC_data' object extracted with features extracted.
write_to	pattern used to export file. Placeholders, like "%d/%s_fromR.%e", will be substituted: -%d: with full path directory of 'obj$fileName' -%p: with first parent directory of 'obj$fileName' -%e: with extension of 'obj$fileName' (without leading .) -%s: with shortname from 'obj$fileName' (i.e. basename without extension). Exported file extension will be deduced from this pattern. Note that it has to be a .fcs.
overwrite	whether to overwrite file or not. Default is FALSE. Note that if TRUE, it will overwrite exported file if path of 'fileName' and deduced from 'write_to' arguments are different. Otherwise, you will get an error saying that overwriting source file is not allowed. Note also that an original file will never be overwritten.
delimiter	an ASCII character to separate the FCS keyword-value pairs. Default is : "/".
cytometer	string, if provided it will be used to fill $CYT keyword. However, when missing $CYT will be filled with obj$description$FCS$instrument if found, or "Image Stream" otherwise.
...	other arguments to be passed. keyword-value pairs can be passed here.

Value

invisibly returns full path of exported file.

gitdemont/IFC documentation built on Feb. 20, 2025, 12:55 a.m.