tame (version 0.2.0)

cluster_frequency: The Frequency of Assignment to Each Cluster

Description

The function cluster_frequency() calculates the number and frequency of individuals assigned to each cluster.

Usage

cluster_frequency(
  object,
  only = NULL,
  clusters = NULL,
  additional_data = NULL,
  ...
)

Value

cluster_frequency() returns a data frame with class cluster_frequency.

• Clustering the name of the clustering.

• Cluster the cluster name.

• Count the number of individuals assigned to the cluster.

• Percent the percent of individuals assigned to the cluster.

Arguments

object

An object for which a summary is desired.

only

<data-masking> Expressions that return a logical value, and are defined in terms of the variables in object and/or additional_data.

The default NULL selects all clusterings in object.

clusters

<tidy-select> An unquoted expression naming the cluster or clusters in object one wants to see summaries of. Names can be used as if they were positions in the data frame, so expressions like I:IV can be used to select a range of clusters.

The default NULL selects all clusters in the chosen clusterings of object.

additional_data

A data frame with additional data that may be (left-)joined onto the parameters in object. This is often used in conjuction with only to select specific clusterings based on additional_data.

...

Additional arguments passed to the specific summary sub-function.

Details

cluster_frequency() calculates the number of individuals assigned to each cluster and the associated frequency of assignment.

Examples

clust <- medic(complications, id = id, atc = atc, k = 3:5)

# make frequency tables
cluster_frequency(clust, k == 5)
cluster_frequency(clust, k < 5, I:III)