Package: tidyclust 0.3.2.9000

Emil Hvitfeldt

tidyclust: A Common API to Clustering

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

Authors:Emil Hvitfeldt [aut, cre], Kelly Bodwin [aut], Posit Software, PBC [cph, fnd]

tidyclust_0.3.2.9000.tar.gz
tidyclust_0.3.2.9000.zip(r-4.7)tidyclust_0.3.2.9000.zip(r-4.6)tidyclust_0.3.2.9000.zip(r-4.5)
tidyclust_0.3.2.9000.tgz(r-4.6-any)tidyclust_0.3.2.9000.tgz(r-4.5-any)
tidyclust_0.3.2.9000.tar.gz(r-4.7-any)tidyclust_0.3.2.9000.tar.gz(r-4.6-any)
tidyclust_0.3.2.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
tidyclust/json (API)

# Install 'tidyclust' in R:

install.packages('tidyclust', repos = c('https://tidymodels.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/tidymodels/tidyclust/issues

Pkgdown/docs site:https://tidyclust.tidymodels.org

On CRAN:

9.84 score 116 stars 377 scripts 3.9k downloads 79 exports 108 dependencies

Last updated from:b35a6cd7dc. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	261
source / vignettes	OK	244
linux-release-x86_64	OK	317
macos-release-arm64	OK	131
macos-oldrel-arm64	OK	127
windows-devel	OK	197
windows-release	OK	201
windows-oldrel	OK	225
wasm-release	OK	192

Exports:.db_clust_fit_dbscan .db_clust_fit_hdbscan .gm_clust_fit_mclust .hier_clust_fit_stats .k_means_fit_ClusterR .k_means_fit_clustMixType .k_means_fit_klaR .k_means_fit_stats .mean_shift_fit_LPCM .mean_shift_fit_meanShiftR %>%augment bandwidth circular cluster_metric_set contr_one_hot control_cluster cut_height db_clust extract_centroids extract_cluster_assignment extract_fit_engine extract_fit_parsnip extract_fit_summary extract_parameter_set_dials extract_preprocessor extract_spec_parsnip finalize_model_tidyclust finalize_workflow_tidyclust fit fit_xy fit_xy.cluster_spec fit.cluster_spec get_tidyclust_colors glance gm_clust hier_clust k_means knit_engine_docs linkage_method list_md_problems load_pkgs make_classes_tidyclust mean_shift min_grid min_points new_cluster_metric new_cluster_spec predict_cluster predict_cluster.cluster_fit predict_raw predict_raw.cluster_fit predict.cluster_fit radius reconcile_clusterings_mapping required_pkgs set_args set_engine set_mode shared_orientation shared_shape shared_size silhouette silhouette_avg silhouette_avg_vec sse_ratio sse_ratio_vec sse_total sse_total_vec sse_within sse_within_total sse_within_total_vec tidy translate_tidyclust translate_tidyclust.default tune tune_cluster values_linkage_method zero_covariance

Dependencies:base64enc bslib cachem class cli clock codetools cpp11 data.table diagram dials DiceDesign digest dplyr evaluate farver fastmap flexclust fontawesome fs furrr future future.apply GauPro generics ggplot2 globals glue gower gtable hardhat highr htmltools ipred isoband jquerylib jsonlite KernSmooth knitr labeling lattice lava lbfgs lifecycle listenv lubridate magrittr MASS Matrix mclust memoise mime mixopt modelenv modeltools nnet numDeriv parallelly parsnip philentropy pillar pkgconfig poorman prettyunits prodlim progressr purrr R6 rappdirs RColorBrewer Rcpp RcppArmadillo RcppParallel recipes rlang rmarkdown rpart rsample S7 sass scales sfd shape slider sparsevctrs splitfngr SQUAREM stringi stringr survival tailor tibble tidyr tidyselect timechange timeDate tinytex tune tzdb utf8 vctrs viridisLite warp withr workflows xfun yaml yardstick

Getting started with tidyclust

Rendered fromtidyclust.Rmdusingknitr::rmarkdown

Last update: 2026-04-28
Started: 2026-04-28

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Augment data with predictions	augment.cluster_fit
Axing a cluster_fit.	axe-cluster_fit axe_call.cluster_fit axe_ctrl.cluster_fit axe_data.cluster_fit axe_env.cluster_fit axe_fitted.cluster_fit
Bandwidth	bandwidth
Model Fit Object Information	cluster_fit
Combine metric functions	cluster_metric_set
Model Specification Information	cluster_spec
One-hot contrast matrix	contr_one_hot
Cut Height	cut_height
Density-Based Spatial Clustering of Applications with Noise (DBSCAN)	db_clust
Extract clusters from model	extract_centroids
Extract cluster assignments from model	extract_cluster_assignment
S3 method to get fitted model summary info depending on engine	extract_fit_summary
Extract elements of a tidyclust model object	extract-tidyclust extract_fit_engine.cluster_fit extract_parameter_set_dials.cluster_spec
Splice final parameters into objects	finalize_model_tidyclust finalize_workflow_tidyclust
Fit a Model Specification to a Data Set	fit.cluster_spec fit_xy.cluster_spec
Computes distance from observations to centroids	get_centroid_dists
Construct a single row summary "glance" of a model, fit, or other object	glance.cluster_fit
Gaussian Mixture Models (GMM)	gm_clust
Gaussian mixture covariance structure parameters	circular gm_clust_params shared_orientation shared_shape shared_size zero_covariance
Hierarchical (Agglomerative) Clustering	hier_clust
K-Means	k_means
The agglomeration Linkage method	linkage_method values_linkage_method
Mean Shift Clustering	mean_shift
Determine the minimum set of model fits	min_grid.cluster_spec
Minimum number of points	min_points
Construct a new clustering metric function	new_cluster_metric
Model predictions	predict.cluster_fit predict_raw.cluster_fit
Prepares data and distance matrices for metric calculation	prep_data_dist
Radius	radius
Relabels clusters to match another cluster assignment	reconcile_clusterings_mapping
Change arguments of a cluster specification	set_args.cluster_spec
Change engine of a cluster specification	set_engine.cluster_spec
Change mode of a cluster specification	set_mode.cluster_spec
Measures silhouette between clusters	silhouette
Measures average silhouette across all observations	silhouette_avg silhouette_avg.cluster_fit silhouette_avg.cluster_spec silhouette_avg.workflow silhouette_avg_vec
Compute the ratio of the WSS to the total SSE	sse_ratio sse_ratio.cluster_fit sse_ratio.cluster_spec sse_ratio.workflow sse_ratio_vec
Compute the total sum of squares	sse_total sse_total.cluster_fit sse_total.cluster_spec sse_total.workflow sse_total_vec
Calculates Sum of Squared Error in each cluster	sse_within
Compute the sum of within-cluster SSE	sse_within_total sse_within_total.cluster_fit sse_within_total.cluster_spec sse_within_total.workflow sse_within_total_vec
Turn a tidyclust model object into a tidy tibble	tidy.cluster_fit
Resolve a Model Specification for a Computational Engine	translate_tidyclust translate_tidyclust.default
Model tuning via grid search	tune_cluster tune_cluster.cluster_spec tune_cluster.workflow
Update a cluster specification	tidyclust_update update.db_clust update.gm_clust update.hier_clust update.k_means update.mean_shift