get_class_names-familiarCollection-method: Get outcome class labels

get_class_names,familiarCollection-methodR Documentation

Get outcome class labels

Description

Outcome classes 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_class_names(x)

Arguments

x

A familiarCollection object.

Details

Labels convert internal class names to the requested label at export or when plotting. Labels can be changed using the set_class_names method.

Value

An ordered array of class labels.

See Also

  • familiarCollection for information concerning the familiarCollection class.

  • set_class_names for updating the name and ordering of classes.


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