_pkgdown.yml

url: https://tidyclust.tidymodels.org

template:
  package: tidytemplate
  bootstrap: 5
  bslib:
    primary: "#CA225E"

  includes:
      in_header: |
        <script defer data-domain="tidyclust.tidymodels.org,all.tidymodels.org" src="https://plausible.io/js/plausible.js"></script>

development:
  mode: auto

reference:
- title: Specifications
  desc: >
    These cluster specification functions are used to specify the type of model
    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
- 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
- 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
- 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
- title: Tuning
  desc: >
    Functions to allow multiple cluster specifications to be fit at once.
  contents:
    - control_cluster
    - tidyclust_update
    - finalize_model_tidyclust
    - tune_cluster
- title: Tuning Objects
  desc: >
    Dials objects.
  contents:
    - 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