search

epiforecasts / scoringutils

Utilities for Scoring and Assessing Predictions
https://epiforecasts.io/scoringutils/
Other
48 stars 20 forks source link

add clearer description of table in metric-details vignette #873

Closed nickreich closed 1 month ago

nickreich commented 1 month ago

I found myself at this page trying to figure out a mapping of which metrics are applicable to which forecast types. But the headers on this table ("D", "C", "B", "Q") are not immediately obvious to me. A sentence of explanation/caption would help the uninitiated understand this when coming to it freshly. (E.g., I think the answer to this question is shown in the table here, but the vignette should stand on its own.)

image

nikosbosse commented 1 month ago

Completely agree - the link you mentioned goes to a description of the outdated scoringutils version which is still on CRAN. The better source is this: https://epiforecasts.io/scoringutils/dev/ And in particular the paper: https://raw.githubusercontent.com/epiforecasts/scoringutils/main/inst/manuscript/manuscript.pdf.

nikosbosse commented 1 month ago

In the code you can look at the functions metrics_binary(), metrics_quantile() etc. (although see https://github.com/epiforecasts/scoringutils/issues/832, we're thinking about turning those into S3 classes)

nikosbosse commented 1 month ago

Closing this as it will be addressed with the next CRAN update and I don't think there is anything immediate to do apart from making sure that CRAN update happens soon. Please feel free to reopen it!