method_selector {tame} | R Documentation |
Method Selector
Description
The method_selector()
is a filtering function for extracting only the
relevant parameters
from a medic object.
Usage
method_selector(clustering, only, additional_data = NULL)
Arguments
only |
< The default |
additional_data |
A data frame with additional data that may be
(left-)joined onto the |
Details
The method_selector()
function is a filtering function used for extracting
the characteristics of the chosen method. This function is used in all of
the investigative functions called by summary()
.
Value
A parameters
data frame with at least the following columns
-
cluster_name
the name of the clustering cluster_name. -
clustering
the name of the clustering group before the number of clusters is chosen. -
linkage
the linkage criteria. -
alpha
the normalization tuning. -
beta
the timing importance tuning. -
gamma
the dose importance tuning. -
theta
the ATC measure tuning. -
k
the number of clusters.
where each row specifies the parameters for the chosen methods. Any
additional columns present in the the outcome are from the
additional_data
.
See Also
cluster_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.