set_learner_names,familiarCollection-method {familiar} | R Documentation |
Rename learners for plotting and export
Description
Tabular exports and figures created from a familiarCollection object can be customised by providing names for the learners.
Usage
## S4 method for signature 'familiarCollection'
set_learner_names(x, old = NULL, new = NULL, order = NULL)
Arguments
x |
A familiarCollection object. |
old |
(optional) Set of old labels to replace. |
new |
Set of replacement labels. The number of replacement labels should
be equal to the number of provided old labels or the full number of labels.
If a subset of labels is to be replaced, both |
order |
(optional) Ordered set of replacement labels. This is used to provide the order in which the labels should be placed, which affects e.g. levels in a plot. If the ordering is not explicitly provided, the old ordering is used. |
Details
Labels convert the internal naming for learners to the requested
label at export or when plotting. This enables the use of more specific
naming, e.g. changing random_forest_rfsrc
to Random Forest
.
Currently assigned labels can be found using the get_learner_names
method.
Value
A familiarCollection object with custom labels for the learners.
See Also
-
familiarCollection for information concerning the familiarCollection class. *
get_learner_names
for obtaining currently assigned labels.