is_stable_k-ConsensusPartition-method: Test whether the current k corresponds to a stable partition

is_stable_k-ConsensusPartition-methodR Documentation

Test whether the current k corresponds to a stable partition

Description

Test whether the current k corresponds to a stable partition

Usage

## S4 method for signature 'ConsensusPartition'
is_stable_k(object, k, stable_PAC = 0.1, ...)

Arguments

object

A ConsensusPartition-class object.

k

Number of subgroups.

stable_PAC

Cutoff for stable PAC.

...

Pass to suggest_best_k,ConsensusPartition-method.

Details

if 1-PAC for the k is larger than 0.9 (10% ambiguity for the partition), cola marks it as a stable partition.

Value

Logical scalar.

Examples

data(golub_cola)
obj = golub_cola["ATC", "skmeans"]
is_stable_k(obj, k = 2)
is_stable_k(obj, k = 3)

jokergoo/cola documentation built on Feb. 29, 2024, 1:41 a.m.