whenToStop: When to Stop

In HectorRDB/Dune: Improving replicability in single-cell RNA-Seq cell type discovery

Description

When to Stop

Usage

whenToStop(merger, p = 1, average_n = NULL)

Arguments

merger	the result from having run Dune on the dataset
p	A value between 0 and 1. We stop when the metric used for merging has improved by p of the final total improvement. Default to 1 (i.e running the full merging).
average_n	Alternatively, you can specify the average number of clusters you want to have.

Details

The Dune process improves the metric. This return the first merging step after which the metric 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

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

HectorRDB/Dune documentation built on Dec. 18, 2020, 8:08 p.m.