split: Splitting Data Based on Clustering Results

In flowClust: Clustering for Flow Cytometry

Description

This method splits data according to results of the clustering (filtering) operation. Outliers identified will be removed by default.

Usage

split(x, f, drop = FALSE, ...)

## S4 method for signature 'data.frame,flowClust'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'matrix,flowClust'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'vector,flowClust'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'flowFrame,flowClust'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'flowFrame,tmixFilterResult'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'flowFrame,flowClustList'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'data.frame,flowClustList'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'matrix,flowClustList'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'vector,flowClustList'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

## S4 method for signature 'flowFrame,tmixFilterResultList'
split(x, f, drop = FALSE,
  population = NULL, split = NULL, rm.outliers = TRUE, ...)

Arguments

x	A numeric vector, matrix, data frame of observations, or object of class flowFrame. This is the object on which flowClust or filter was performed.
f	Object returned from flowClust or filter.
drop	A logical value indicating whether to coerce a column matrix into a vector, if applicable. Default is FALSE, meaning that a single-column matrix will be retained.
...	Further arguments to be passed to or from other methods.
population	An optional argument which specifies how to split the data. If specified, it takes a list object with named or unnamed elements each of which is a numeric vector specifying which clusters are included. If this argument is left unspecified, the data object will be split into K subsets each of which is formed by one out of the K clusters used to model the data. See examples for more details.
split	This argument is deprecated. Should use population instead.
rm.outliers	A logical value indicating whether outliers are removed or not.

Value

A list object with elements each of which is a subset of x and also retains the same class as x. If the split argument is specified with a list of named elements, those names will be used to name the corresponding elements in the resultant list object.

Usage

split(x, f, drop=FALSE, population=NULL, split=NULL, rm.outliers=TRUE, ...)

Author(s)

Raphael Gottardo <[e-mail]>, Kenneth Lo <[e-mail]>

References

Lo, K., Brinkman, R. R. and Gottardo, R. (2008) Automated Gating of Flow Cytometry Data via Robust Model-based Clustering. Cytometry A 73, 321-332.

See Also

Subset, flowClust, filter

flowClust documentation built on Nov. 8, 2020, 7:34 p.m.