tidyclust0.2.4 package

A Common API to Clustering

augment

Augment data with predictions

cluster_fit

Model Fit Object Information

cluster_metric_set

Combine metric functions

cluster_spec

Model Specification Information

control_cluster

Control the fit function

convert_helpers

Helper functions to convert between formula and matrix interface

cut_height

Cut Height

details_hier_clust_stats

Hierarchical (Agglomerative) Clustering via stats

details_k_means_ClusterR

K-means via ClusterR

details_k_means_clustMixType

K-means via clustMixType

details_k_means_klaR

K-means via klaR

details_k_means_stats

K-means via stats

dot-hier_clust_fit_stats

Simple Wrapper around hclust function

dot-k_means_fit_ClusterR

Simple Wrapper around ClusterR kmeans

dot-k_means_fit_clustMixType

Simple Wrapper around clustMixType kmeans

dot-k_means_fit_klaR

Simple Wrapper around klaR kmeans

dot-k_means_fit_stats

Simple Wrapper around stats kmeans

empty_ellipses

Get colors for tidyclust text.

extract_centroids

Extract clusters from model

extract_cluster_assignment

Extract cluster assignments from model

extract_fit_summary

S3 method to get fitted model summary info depending on engine

extract-tidyclust

Extract elements of a tidyclust model object

finalize_model_tidyclust

Splice final parameters into objects

fit

Fit a Model Specification to a Data Set

get_centroid_dists

Computes distance from observations to centroids

glance.cluster_fit

Construct a single row summary "glance" of a model, fit, or other obje...

hier_clust

Hierarchical (Agglomerative) Clustering

k_means

K-Means

knit_engine_docs

Knit engine-specific documentation

linkage_method

The agglomeration Linkage method

list_md_problems

Locate and show errors/warnings in engine-specific documentation

load_pkgs.cluster_spec

Quietly load package namespace

make_classes_tidyclust

Prepend a new class

min_grid.cluster_spec

Determine the minimum set of model fits

new_cluster_metric

Construct a new clustering metric function

new_cluster_spec

Functions required for tidyclust-adjacent packages

other_predict

Other predict methods.

predict.cluster_fit

Model predictions

prep_data_dist

Prepares data and distance matrices for metric calculation

reconcile_clusterings_mapping

Relabels clusters to match another cluster assignment

reexports

Objects exported from other packages

set_args.cluster_spec

Change arguments of a cluster specification

set_engine.cluster_spec

Change engine of a cluster specification

set_mode.cluster_spec

Change mode of a cluster specification

silhouette_avg

Measures average silhouette across all observations

silhouette

Measures silhouette between clusters

sse_ratio

Compute the ratio of the WSS to the total SSE

sse_total

Compute the total sum of squares

sse_within_total

Compute the sum of within-cluster SSE

sse_within

Calculates Sum of Squared Error in each cluster

tidy.cluster_fit

Turn a tidyclust model object into a tidy tibble

tidyclust_update

Update a cluster specification

tidyclust-package

tidyclust: A Common API to Clustering

translate_tidyclust

Resolve a Model Specification for a Computational Engine

tune_cluster

Model tuning via grid search

A common interface to specifying clustering models, in the same style as 'parsnip'. Creates unified interface across different functions and computational engines.

  • Maintainer: Emil Hvitfeldt
  • License: MIT + file LICENSE
  • Last published: 2025-01-27