is_best_k-ConsensusPartition-method: Test whether the current k is the best/optional k

is_best_k-ConsensusPartition-methodR Documentation

Test whether the current k is the best/optional k

Description

Test whether the current k is the best/optional k

Usage

## S4 method for signature 'ConsensusPartition'
is_best_k(object, k, ...)

Arguments

object

A ConsensusPartition-class object.

k

Number of subgroups.

...

Pass to suggest_best_k,ConsensusPartition-method.

Details

Optional best k is also assigned as TRUE.

Value

Logical scalar.

Examples

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

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