immunoClust.methods: Acessors and Methods for immunoClust Objects

In immunoClust: immunoClust - Automated Pipeline for Population Detection in Flow Cytometry

Description

Documentation of the accessors and methods for immunoClust-objects

Arguments

object, immunoClust	an object of class immunoClust as return by cell.process.
cls	cluster subset for retrieved slot values.
par	parameter subset for retrieved slot values.

Accessors

nobs

the number of cell events clustered

Usage:

nobs(immunoClust)

ncls

the number of clusters.

Usage:

ncls(immunoClust)

npar

the number of parameters measured, cell-clustered

Usage:

npar(immunoClust)

parameters, parameters<-

extracts or replaces the names of measured, cell-clustered parameters

Usage:

parameters(immunoClust)

parameters(immunoClust) <- value

label

the clustering label, that is the assignment of the cell-events to the clusters.

Usage:

label(immunoClust)

weights

the clustering weights for the cluster selection (all cluster by default)

Usage:

weights(immunoClust,cls=seq_len(ncls(immunoClust)))

mu

the cluster mean values for the cluster and parameter selection (all cluster and all parameter by default)

Usage:

mu(immunoClust, cls=seq_len(ncls(immunoClust)), par=seq_len(npar(immunoClust)))

sigma

the cluster co-variance values for the cluster and parameter selection (all cluster and all parameter by default)

Usage:

sigma(immunoClust, cls=seq_len(ncls(immunoClust)), par=seq_len(npar(immunoClust)))

posterior

the posterior probabilities of cluster membership for each event

Usage:

posterior(immunoClust)

events

the cell-event numbers for the cluster selection (all cluster by default)

Usage:

events(immunoClust, ncls=seq_len(ncls(immunoClust)))

Methods

subset

Builds the immunoClust-object for a parameter subset

Usage:

res <- subset(immunoClust, par)

transformParams

Scales and translates the cluster means of the immunoClust-object in each parameter

Usage:

res <- transformParams(immunoClust, scale=c(), offset=c())

Author(s)

Till Sörensen [e-mail]

See Also

immunoClust-object

Examples

###
data(dat.exp)
## cell.clustering result for dat.fcs
res <- dat.exp[[1]]
nobs(res)
ncls(res)

immunoClust documentation built on Nov. 8, 2020, 5:19 p.m.