Skip to content

Commit

Permalink
Make documentation for apply_metrics more consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
nikosbosse committed Nov 20, 2023
1 parent 59249cc commit 3694e48
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions R/score.R
Original file line number Diff line number Diff line change
Expand Up @@ -261,13 +261,13 @@ score.scoringutils_quantile <- function(data, metrics = metrics_quantile, ...) {
}


#' Helper Function To Apply a List Of Functions To a Data Table of Forecasts
#' @description The function applies a list of functions to a data table of
#' forecasts. The function is used within `score()` to apply all
#' scoring rules to the data.
#' Function calls are wrapped in `run_safely()` to catch errors and to make
#' sure that only arguments are passed to the function that are actually
#' accepted by the function.
#' @title Apply A List Of Functions To A Data Table Of Forecasts
#' @description This helper function applies scoring rules (stored as a list of
#' functions) to a data table of. `apply_metrics` is used within `score()` to
#' apply all scoring rules to the data.
#' Scoring rules are wrapped in [run_safely()] to catch errors and to make
#' sure that only arguments are passed to the scoring rule that are actually
#' accepted by it.
#' @inheritParams score
#' @return A data table with the forecasts and the calculated metrics
apply_metrics <- function(data, metrics, ...) {
Expand Down
14 changes: 7 additions & 7 deletions man/apply_metrics.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3694e48

Please sign in to comment.