select_metrics: Select columns with evaluation metrics and model definitions

View source: R/select_metrics.R

select_metricsR Documentation

Select columns with evaluation metrics and model definitions

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("maturing")}

When reporting results, we might not want all the nested tibbles and process information columns. This function selects the evaluation metrics and model formulas only.

If an expected column is not in the `results` tibble, it is simply ignored.

Usage

select_metrics(results, include_definitions = TRUE, additional_includes = NULL)

Arguments

results

Results tibble. E.g. from cross_validate() or evaluate().

include_definitions

Whether to include the Dependent, Fixed and (possibly) Random and HParams columns. (Logical)

additional_includes

Names of additional columns to select. (Character)

Value

The results tibble with only the metric and model definition columns.

Author(s)

Ludvig Renbo Olsen, r-pkgs@ludvigolsen.dk


cvms documentation built on Sept. 11, 2024, 6:22 p.m.