whenToStop: When to Stop

Description Usage Arguments Details Value Examples

View source: R/utils.R

Description

When to Stop

Usage

1
whenToStop(merger, p)

Arguments

merger

the result from having run Dune on the dataset

p

A value between 0 and 1. We stop when the mean ARI has improved by p of the final total improvement. Default to 1 (i.e running the full merging).

Details

The Dune process improves the mean ARI. This return the first merging step after which the mean ARI has been improved by p of the total. Setting p = 1 just return the number of merges.

Value

An integer giving the step where to stop.

Examples

1
2
3
data("clusMat", package = "Dune")
merger <- Dune(clusMat = clusMat)
whenToStop(merger, p = .5)

Dune documentation built on Nov. 8, 2020, 7:55 p.m.