Learn R Programming

familiar (version 1.5.0)

get_risk_group_names,familiarCollection-method: 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 familiarCollection
get_risk_group_names(x)

Value

An ordered array of risk group labels.

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.

See Also

  • familiarCollection for information concerning the familiarCollection class.

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