get_learner_names-familiarCollection-method: Get current learner name labels

get_learner_names,familiarCollection-methodR Documentation

Get current learner name labels

Description

Learners 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_learner_names(x)

Arguments

x

A familiarCollection object.

Details

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

Value

An ordered array of learner name labels.

See Also

  • familiarCollection for information concerning the familiarCollection class.

  • set_learner_names for updating the name of learners and their ordering.


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