summarize_accuracy_metrics: Summarize Accuracy Metrics

View source: R/yardstick-metric-sets.R

summarize_accuracy_metricsR Documentation

Summarize Accuracy Metrics

Description

This is an internal function used by modeltime_accuracy().

Usage

summarize_accuracy_metrics(data, truth, estimate, metric_set)

Arguments

data

A data.frame containing the truth and estimate columns.

truth

The column identifier for the true results (that is numeric).

estimate

The column identifier for the predicted results (that is also numeric).

metric_set

A yardstick::metric_set() that is used to summarize one or more forecast accuracy (regression) metrics.

Examples

library(dplyr)

predictions_tbl <- tibble(
    group = c("model 1", "model 1", "model 1",
              "model 2", "model 2", "model 2"),
    truth = c(1, 2, 3,
              1, 2, 3),
    estimate = c(1.2, 2.0, 2.5,
                 0.9, 1.9, 3.3)
)

predictions_tbl %>%
    group_by(group) %>%
    summarize_accuracy_metrics(
        truth, estimate,
        metric_set = default_forecast_accuracy_metric_set()
    )


modeltime documentation built on Oct. 23, 2024, 1:07 a.m.