Compute the total sum of squares

Compute the total sum of squares

Usage

sse_total(object, ...)

# S3 method for cluster_spec
sse_total(object, ...)

# S3 method for cluster_fit
sse_total(object, new_data = NULL, dist_fun = NULL, ...)

# S3 method for workflow
sse_total(object, new_data = NULL, dist_fun = NULL, ...)

sse_total_vec(object, new_data = NULL, dist_fun = Rfast::dista, ...)

Arguments

object

A fitted kmeans tidyclust model

...

Other arguments passed to methods.

new_data

A dataset to predict on. If NULL, uses trained clustering.

dist_fun

A function for calculating distances to centroids. Defaults to Euclidean distance on processed data.

Value

A tibble with 3 columns; .metric, .estimator, and .estimate.

See also

Other cluster metric: silhouette_avg(), sse_ratio(), sse_within_total()

Examples

kmeans_spec <- k_means(num_clusters = 5) %>%
  set_engine("stats")

kmeans_fit <- fit(kmeans_spec, ~., mtcars)

sse_total(kmeans_fit)
#> # A tibble: 1 × 3
#>   .metric   .estimator .estimate
#>   <chr>     <chr>          <dbl>
#> 1 sse_total standard     623387.

sse_total_vec(kmeans_fit)
#> [1] 623387.5