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

Description Usage Arguments Details Value Examples

Description

Test whether the current k is the best/optional k

Usage

1
2
## 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

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

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