cluster_selector: Finding chosen cluster names

View source: R/extractors.R

cluster_selectorR Documentation

Finding chosen cluster names

Description

The cluster_selector() function finds the name of the chosen clusters.

Usage

cluster_selector(clustering, clusters = NULL)

Arguments

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.

Details

The cluster_selector() finds the names of the chosen clusters present in the clustering medic object. This function is used in all of the investigative functions called by summary().

Value

A character vector with the names of the chosen clusters.

See Also

method_selector() is another selector method used through out the package.

enrich() is a joining function used for enriching the clustering characteristics with user-defined data.

summary.medic() is the main function for summarizing the clustering results.


tame documentation built on April 12, 2025, 1:40 a.m.