num_clusters: Number of Clusters

View source: R/param_num_clusters.R

num_clustersR Documentation

Number of Clusters

Description

Used in most tidyclust models.

Usage

num_clusters(range = c(1L, 10L), trans = NULL)

Arguments

range

A two-element vector holding the defaults for the smallest and largest possible values, respectively. If a transformation is specified, these values should be in the transformed units.

trans

A trans object from the scales package, such as scales::transform_log10() or scales::transform_reciprocal(). If not provided, the default is used which matches the units used in range. If no transformation, NULL.

Examples

num_clusters()

topepo/dials documentation built on April 23, 2024, 5:32 a.m.