View source: R/get_-functions.R
get_metrics | R Documentation |
When applying a scoring rule via score()
, the names of the scoring rules
become column names of the
resulting data.table. In addition, an attribute metrics
will be
added to the output, holding the names of the scores as a vector.
This is done so that a function like get_forecast_unit()
can still
identify which columns are part of the forecast unit and which hold a score.
get_metrics()
access and returns this attribute. If there is no
attribute, the function will return NULL. Users can control whether the
function should error instead via the error
argument.
get_metrics()
also checks whether the names of the scores stored in
the attribute are column names of the data and will throw a warning if not.
This can happen if you rename columns after scoring. You can either run
score()
again, specifying names for the scoring rules manually, or you
can update the attribute manually using
attr(scores, "metrics") <- c("names", "of", "your", "scores")
(the
order does not matter).
get_metrics(scores, error = FALSE)
scores |
A data.table with an attribute |
error |
Throw an error if there is no attribute called |
Character vector with the names of the scoring rules that were used
for scoring or NULL
if no scores were computed previously.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.