hier_clust.md
In tidyclust: A Common API to Clustering

bad input

Code
  hier_clust(mode = "bogus")
Condition
  Error in `hier_clust()`:
  ! "bogus" is not a known mode for model `hier_clust()`.

Code
  bt <- set_engine(hier_clust(linkage_method = "bogus"), "stats")
  fit(bt, mpg ~ ., mtcars)
Condition
  Error in `stats::hclust()`:
  ! invalid clustering method bogus

Code
  translate_tidyclust(hier_clust(), engine = NULL)
Condition
  Error in `translate_tidyclust.default()`:
  ! Please set an engine.

Code
  translate_tidyclust(hier_clust(formula = ~x))
Condition
  Error in `hier_clust()`:
  ! unused argument (formula = ~x)

printing

Code
  hier_clust()
Output
  Hierarchical Clustering Specification (partition)

  Main Arguments:
    linkage_method = complete

  Computational engine: stats

Code
  hier_clust(num_clusters = 10)
Output
  Hierarchical Clustering Specification (partition)

  Main Arguments:
    num_clusters = 10
    linkage_method = complete

  Computational engine: stats

updating

Code
  update(hier_clust(num_clusters = 5), num_clusters = tune())
Output
  Hierarchical Clustering Specification (partition)

  Main Arguments:
    num_clusters = tune()
    linkage_method = complete

  Computational engine: stats

check_args.hier_clust() errors on negative num_clusters

Code
  spec <- set_engine(hier_clust(num_clusters = -1), "stats")
  fit(spec, ~., data = mtcars)
Condition
  Error in `check_args()`:
  ! The number of centers should be >= 0.