diff --git a/_pkgdown.yml b/_pkgdown.yml index 7749c25..5649d24 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -7,8 +7,9 @@ template: primary: "#CA225E" includes: - in_header: | - + in_header: | + + development: mode: auto @@ -20,64 +21,64 @@ reference: you want to do. These functions work in a similar fashion to the [model specification function from parsnip](https://parsnip.tidymodels.org/reference/index.html#models). contents: - - k_means - - hier_clust - - cluster_spec - - cluster_fit + - k_means + - hier_clust + - cluster_spec + - cluster_fit - title: Fit and Inspect desc: > These functions are the generics that are supported for specifications created with tidyclust. contents: - - fit.cluster_spec - - set_args.cluster_spec - - set_engine.cluster_spec - - set_mode.cluster_spec - - augment.cluster_fit - - glance.cluster_fit - - tidy.cluster_fit - - extract-tidyclust + - fit.cluster_spec + - set_args.cluster_spec + - set_engine.cluster_spec + - set_mode.cluster_spec + - augment.cluster_fit + - glance.cluster_fit + - tidy.cluster_fit + - extract-tidyclust - title: Prediction desc: > Once the cluster specification have been fit, you are likely to want to look at where the clusters are and which observations are associated with which cluster. contents: - - predict.cluster_fit - - extract_cluster_assignment - - extract_centroids + - predict.cluster_fit + - extract_cluster_assignment + - extract_centroids - title: Model based performance metrics desc: > These metrics use the fitted clustering model to extract values denoting how well the model works. contents: - - cluster_metric_set - - silhouette_avg - - sse_ratio - - sse_total - - sse_within_total - - silhouette - - sse_within + - cluster_metric_set + - silhouette_avg + - sse_ratio + - sse_total + - sse_within_total + - silhouette + - sse_within - title: Tuning desc: > Functions to allow multiple cluster specifications to be fit at once. contents: - - control_cluster - - tidyclust_update - - finalize_model_tidyclust - - tune_cluster + - control_cluster + - tidyclust_update + - finalize_model_tidyclust + - tune_cluster - title: Tuning Objects desc: > Dials objects. contents: - - cut_height - - linkage_method + - cut_height + - linkage_method - title: Developer tools contents: - - extract_fit_summary - - get_centroid_dists - - new_cluster_metric - - prep_data_dist - - reconcile_clusterings_mapping - - translate_tidyclust - - min_grid.cluster_spec + - extract_fit_summary + - get_centroid_dists + - new_cluster_metric + - prep_data_dist + - reconcile_clusterings_mapping + - translate_tidyclust + - min_grid.cluster_spec