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

<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.

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.

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

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.


[Package tame version 0.0.1 Index]