cluster_metric_set: Combine metric functions

In tidyclust: A Common API to Clustering

Combine metric functions

Description

cluster_metric_set() allows you to combine multiple metric functions together into a new function that calculates all of them at once.

Usage

cluster_metric_set(...)

Arguments

...	The bare names of the functions to be included in the metric set. These functions must be cluster metrics such as sse_total(), sse_ratio(), or silhouette_avg().

Details

All functions must be cluster metrics. To include a metric that wraps a built-in metric with custom arguments, such as silhouette_avg() with a non-default dist_fun, first wrap it with new_cluster_metric() so that it carries the cluster_metric class. See the examples in new_cluster_metric().

Value

A cluster_metric_set() object, combining the use of all input metrics.

See Also

new_cluster_metric()

tidyclust documentation built on June 20, 2026, 9:08 a.m.