collect_classes-ConsensusPartitionList-method {cola} | R Documentation

## Collect classes from ConsensusPartitionList object

### Description

Collect classes from ConsensusPartitionList object

### Usage

    ## S4 method for signature 'ConsensusPartitionList'
    collect_classes(object, k, show_column_names = FALSE,
        anno = get_anno(object), anno_col = get_anno_col(object))

### Arguments

`object` | A `ConsensusPartitionList-class` object returned by `run_all_consensus_partition_methods`.
`k` | Number of partitions.
`show_column_names` | Whether show column names in the heatmap (which is the column name in the original matrix).
`anno` | A data frame of annotations for the original matrix columns. By default it uses the annotations specified in `run_all_consensus_partition_methods`.
`anno_col` | A list of colors (color is defined as a named vector) for the annotations. If `anno` is a data frame, `anno_col` should be a named list where names correspond to the column names in `anno`.

### Details

There are following panels in the plot:

- a heatmap showing partitions predicted from all methods where the top annotation is the consensus partition summarized from partitions from all methods, weighted by mean silhouette scores in every single method.

- a row barplot annotation showing the mean silhouette scores for different methods.

The row clustering is applied on the dissimilarity matrix calculated by `cl_dissimilarity` with the `comembership` method.

The brightness of the color corresponds to the silhouette scores for the consensus partition in each method.

### Value

No value is returned.

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### Examples

    data(cola_rl)
    collect_classes(cola_rl, k = 3)

[Package cola version 1.0.1 Index]