suggest_best_k-ConsensusPartition-method: Suggest the best number of subgroups

Description Usage Arguments Details Value See Author(s) Examples

Description

Suggest the best number of subgroups

Usage

1
2
## S4 method for signature 'ConsensusPartition'
suggest_best_k(object, jaccard_index_cutoff = 0.95)

Arguments

object

A ConsensusPartition-class object.

jaccard_index_cutoff

The cutoff for Jaccard index for comparing to previous k.

Details

The best k is selected according to following rules:

Additionally, if 1-PAC for the best k is larger than 0.9 (10% ambiguity for the partition), cola marks it as a stable partition. It should be noted that it is difficult to find the best k deterministically, we encourage users to compare results for all k and determine a proper one which best explain their studies.

Value

The best k.

See

The selection of the best k can be visualized by select_partition_number.

Author(s)

Zuguang Gu <z.gu@dkfz.de>

Examples

1
2
3
data(golub_cola)
obj = golub_cola["ATC", "skmeans"]
suggest_best_k(obj)

cola documentation built on Nov. 8, 2020, 8:12 p.m.