A Common API to Clustering
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘tidyclust’ version 0.2.1
Help Pages
| augment.cluster_fit | 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 |
| cut_height | Cut Height |
| extract-tidyclust | Extract elements of a tidyclust model object |
| extract_centroids | Extract clusters from model |
| extract_cluster_assignment | Extract cluster assignments from model |
| extract_fit_engine.cluster_fit | Extract elements of a tidyclust model object |
| extract_fit_summary | S3 method to get fitted model summary info depending on engine |
| extract_parameter_set_dials.cluster_spec | Extract elements of a tidyclust model object |
| finalize_model_tidyclust | Splice final parameters into objects |
| finalize_workflow_tidyclust | Splice final parameters into objects |
| fit.cluster_spec | Fit a Model Specification to a Data Set |
| fit_xy.cluster_spec | 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 object |
| hier_clust | Hierarchical (Agglomerative) Clustering |
| k_means | K-Means |
| linkage_method | The agglomeration Linkage method |
| min_grid.cluster_spec | Determine the minimum set of model fits |
| new_cluster_metric | Construct a new clustering metric function |
| predict.cluster_fit | Model predictions |
| predict_raw.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 |
| 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 | Measures silhouette between clusters |
| silhouette_avg | Measures average silhouette across all observations |
| silhouette_avg.cluster_fit | Measures average silhouette across all observations |
| silhouette_avg.cluster_spec | Measures average silhouette across all observations |
| silhouette_avg.workflow | Measures average silhouette across all observations |
| silhouette_avg_vec | Measures average silhouette across all observations |
| sse_ratio | Compute the ratio of the WSS to the total SSE |
| sse_ratio.cluster_fit | Compute the ratio of the WSS to the total SSE |
| sse_ratio.cluster_spec | Compute the ratio of the WSS to the total SSE |
| sse_ratio.workflow | Compute the ratio of the WSS to the total SSE |
| sse_ratio_vec | Compute the ratio of the WSS to the total SSE |
| sse_total | Compute the total sum of squares |
| sse_total.cluster_fit | Compute the total sum of squares |
| sse_total.cluster_spec | Compute the total sum of squares |
| sse_total.workflow | Compute the total sum of squares |
| sse_total_vec | Compute the total sum of squares |
| sse_within | Calculates Sum of Squared Error in each cluster |
| sse_within_total | Compute the sum of within-cluster SSE |
| sse_within_total.cluster_fit | Compute the sum of within-cluster SSE |
| sse_within_total.cluster_spec | Compute the sum of within-cluster SSE |
| sse_within_total.workflow | Compute the sum of within-cluster SSE |
| sse_within_total_vec | Compute the sum of within-cluster SSE |
| tidy.cluster_fit | Turn a tidyclust model object into a tidy tibble |
| tidyclust_update | Update a cluster specification |
| translate_tidyclust | Resolve a Model Specification for a Computational Engine |
| translate_tidyclust.default | Resolve a Model Specification for a Computational Engine |
| tune_cluster | Model tuning via grid search |
| tune_cluster.cluster_spec | Model tuning via grid search |
| tune_cluster.workflow | Model tuning via grid search |
| update.hier_clust | Update a cluster specification |
| update.k_means | Update a cluster specification |
| values_linkage_method | The agglomeration Linkage method |