identifier-methods: Retrieve the GUID of flowCore objects

In RGLab/flowCore: flowCore: Basic structures for flow cytometry data

Retrieve the GUID of flowCore objects

Description

Retrieve the GUID (globally unique identifier) of a flowFrame that was generated by the cytometer or the identifier of a filter or filterResult given by the analyst.

Usage

identifier(object)

Arguments

object

Object of class flowFrame, filter or filterResult.

Details

GUID or Globally Unique Identifier is a pseudo-random number used in software applications. While each generated GUID is not guaranteed to be unique, the total number of unique keys (2\^128) is so large that the probability of the same number being generated twice is very small.

Note that if no GUID has been recorded along with the FCS file, the name of the file is returned.

Value

Character vector representing the GUID or the name of the file.

Methods

identifier(object = "filter")

Return identifier of a filter object.

identifier(object = "filterReference")

Return identifier of a filterReference object.

identifier(object = "filterResult")

Return identifier of a filterResult object.

identifier(object = "transform")

Return identifier of a transform object.

identifier(object = "flowFrame")

Return GUID from the description slot of a flowFrame object or, alternatively, the name of the input FCS file in case none can be found. For flowFrame objects there also exists a replacement method.

Author(s)

N. LeMeur

Examples

 samp <- read.FCS(system.file("extdata","0877408774.B08", package="flowCore"))
 identifier(samp)

RGLab/flowCore documentation built on Aug. 26, 2024, 8:52 a.m.