generics: Generic function definitions in immunoClust

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

Description

Collection of generic function definitions used in immunoClust either for an immunoClust or an immunoMeta object.

Usage

nsam(object, ...)

sam_ncls(object, ...)

sam_clsWeights(object, ...)

sam_clsEvents(object, ...)

sam_clsMu(object, ...)

sam_clsSigma(object, ...)

nobs(object, ...)

npar(object, ...)

ncls(object, ...)

weights(object, ...)

mu(object, ...)

sigma(object, ...)

label(object, ...)

posterior(object, ...)

subset(x, ...)

parameters(object, ...)

parameters(object, ...) <- value

transformParams(object, ...)

Arguments

object, x	an object to apply the function.
value	a value to apply in replace method.
...	addionional options to be passed to methods

Value

The appropriate value for the specific cal (see dection Details).

Details

nsam

returns the number of cell-event immunoClust-objects co-clustered in the immunoMeta-object.

sam_clsWeights

returns the cluster weights of all samples cell-clusters.

sam_clsEVents

returns the cluster event numbers of all samples cell-clusters.

sam_clsMu

returns the cluster means of all samples cell-clusters.

sam_clsSigma

returns the cluster co-variance matrices of all samples cell-clusters.

nobs

already generic in stats. Here, returns the number of clustered objects either cell-events or cell-clusters in cell event or meta clustering.

npar

returns the number of parameters used for clustering.

ncls

returns the number of cluster, either cell-event cluster or meta-cluster.

weights

already generic in stats. Here, returns the weights of the mixture models for the cell-event of meta-clustering.

mu

returns the cluster means.

sigma

already generic in stats. Here, returns the co-variance matrices of the clusters.

label

returns the cluster label, i.e. the assignment of the clustered objects to the clusters.

posterior

returns the posterior probabilities of cluster membership for the clustered objects.

events

returns the number of cell-events for the clusters.

subset

alreay generic in stats. Here, returns an object with mixture model on a subset of parameters.

parameters

already generic in flowCore. Here, lists the parameters used for clustering.

parameters<-

Modifies the list of parameters used for clustering.

transformParam

return an object with transformed mixture model parameters.

Author(s)

Till Sörensen [e-mail]

See Also

immunoClust, immunoMeta

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