parameters-methods: Obtain information about parameters for flow cytometry...

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

Obtain information about parameters for flow cytometry objects.

Description

Many different objects in flowCore are associated with one or more parameters. This includes filter, flowFrame and parameterFilter objects that all either describe or use parameters.

Usage

parameters(object, ...)

Arguments

object	Object of class filter, flowFrame or parameterFilter.
...	Further arguments that get passed on to the methods.

Value

When applied to a flowFrame object, the result is an AnnotatedDataFrame describing the parameters recorded by the cytometer. For other objects it will usually return a vector of names used by the object for its calculations.

Methods

parameters(object = "filter")

Returns for all objects that inherit from filter a vector of parameters on which a gate is defined.

parameters(object = "parameterFilter")

see above

parameters(object = "setOperationFilter")

see above

parameters(object = "filterReference")

see above

parameters(object = "flowFrame")

Returns an AnnotatedDataFrame containing detailed descriptions about the measurement parameters of the flowFrame. For flowFrame objects there also exists a replacement method.

Author(s)

B. Ellis, N. Le Meur, F. Hahne

Examples

 samp <- read.FCS(system.file("extdata","0877408774.B08", package="flowCore"))
 parameters(samp)
 print(samp@parameters@data)

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