immunoMeta-class {immunoClust} | R Documentation

## 'immunoMeta': a class for storing meta-clustering results

### Description

The `immunoMeta` object contains the clustering results in the immunoClust-pipeline obtained by `meta.process`. Additionally, it offers methods to structure the meta-clusters and build up a hierarchical annotation tree.

### Usage

    immunoMeta(res,dat,gating)

    ## S3 method for class 'immunoMeta'
    summary(object, ...)
    ## S3 method for class 'immunoMeta'
    show(object)

### Arguments

`res` | An `immunoClust` object as a result of the meta-clustering.
`dat` | The data on which the meta-clustering was performed.
`gating` | a hierarchial structure annotation of the meta-clusters.
`object` | An object of class `immunoMeta` as returned by the `meta.process` functions of the immunoClust-pipeline.
`...` | additinal options for underlying methods.

### Value

An object of class `immunoMeta` has the following slots:

`dat.clusters` | A `dat` list-object of the cell event clusters used for meta-clustering.
`res.clusters` | The `immunoClust-object` of the fitted meta-clustering mixture model.
`dat.scatter` | A `dat` list-object of the scatter parameters for the cell event clusters used for scatter clustering.
`res.scatter` | The `immunoClust-object` of the fitted scatter-clustering mixture model.
`gating` | A list-object containing the hierarchical annotation-tree.

The components of the `dat` list-objects are:

`P` | The number of parameters for the cell event clusters.
`N` | The number of cell-clustering experiments.
`K` | The N-dimensional vector with the numbers of cell event clusters in each experiment. The total number of clusters is sum(K).
`W` | The totK-dimensional vector with the mixture proportions of all clusters.
`M` | The totK x P-dimensional matrix of all cluster means.
`S` | The totK x P x P-dimensional matrix of all cluster covariance matrices.
`expNames` | The N-dimensional character vector with the cell-clustering experiment names.
`expEvents` | The N-dimensional vector with the numbers of events in each cell-clustering experiment.
`clsEvents` | The totK-dimensional vector with the number of events in each cluster.
`desc` | The P-dimensional character vector with the parameter description.

### Author(s)

Till Sörensen till-antoni.soerensen@charite.de

### See Also

`meta.process`

### Examples

    data(dat.meta)
    summary(dat.meta)

[Package immunoClust version 1.20.1 Index]