kmeansFilter-class {flowCore}R Documentation

One dimensional k-means filters

Description

A filter that performs one-dimensional k-means (Lloyd-Max) clustering on a parameter

Usage

kmeansFilter(filterId = "kmeans",...)

Arguments

filterId An optional parameter that sets the filterId of this gate.
... This gate takes a parameter name and a list of populations

Details

The one-dimensional k-means filter is a multiple population filter capable of operating on a single parameter. It takes either a list containing a single element or a parameter argument associated with two or more populations. Populations are considered to be ordered such that the population with the smallest mean intensity will be the first population in the list and the population with the highest mean intensity will be the last population listed.

Value

Returns a kmeansFilter object for use in filtering flowFrames or other flow cytometry objects.

Author(s)

B. Ellis and N. LeMeur

See Also

flowFrame, filter

Examples

a.1 = kmeansFilter("a","FSC-H"=c("Pop1","Pop2","Pop3"))
#is equivalent to
b.1 = kmeansFilter("b",list("FSC-H"=c("Pop1","Pop2","Pop3")))
summary(filter(read.FCS(system.file("extdata","0877408774.B08", package="flowCore")),a.1))
summary(filter(read.FCS(system.file("extdata","0877408774.B08", package="flowCore")),b.1))

[Package flowCore version 1.0.2 Index]