markernames: get or update the marker names

markernamesR Documentation

get or update the marker names

Description

marker names corresponds to the 'desc' column of the phenoData of the flowFrame.

Usage

markernames(object, ...)

## S4 method for signature 'flowFrame'
markernames(object)

markernames(object) <- value

## S4 replacement method for signature 'flowFrame'
markernames(object) <- value

## S4 method for signature 'flowSet'
markernames(object)

## S4 replacement method for signature 'flowSet'
markernames(object) <- value

Arguments

object

flowFrame or flowSet

...

not used

value

a named list or character vector. the names corresponds to the name(channel) and actual values are the desc(marker).

Details

When extract marker names from a flowSet, it throws the warning if the marker names are not all the same across samples.

Value

marker names as a character vector. The marker names for FSC,SSC and Time channels are automatically excluded in the returned value. When object is a flowSet and the marker names are not consistent across flowFrames, it returns a list of unique marker sets.

Examples


data(GvHD)
fr <- GvHD[[1]]
markernames(fr)

chnls <- c("FL1-H", "FL3-H")
markers <- c("CD15", "CD14")
names(markers) <- chnls
markernames(fr) <- markers
markernames(fr)

fs <- GvHD[1:3]
markernames(fs)

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