get_risk_group_names-familiarCollection-method: Get current risk group labels

In familiar: End-to-End Automated Machine Learning and Model Evaluation

Get current risk group labels

Description

Risk groups in familiarCollection objects can have custom names for export and plotting. This function retrieves the currently assigned names.

Usage

## S4 method for signature 'familiarCollection'
get_risk_group_names(x)

Arguments

x	A familiarCollection object.

Details

Labels convert internal naming of risk groups to the requested label at export or when plotting. Labels can be changed using the set_risk_group_names method.

Value

An ordered array of risk group labels.

See Also

• familiarCollection for information concerning the familiarCollection class.

• set_risk_group_names for updating the name and ordering of risk groups.

familiar documentation built on Sept. 30, 2024, 9:18 a.m.