Issue #758 - Update metrics vignette

nikosbosse commented 4 months ago

Description

Related to #758. The old vignettes related to our metrics and scoring rules were outdated. This PR creates a first proposal for a replacement. The vignette is not completely done (e.g. a section on the PIT is missing and there is more that one could say related to when to pick which score). However, I think it makes sense to have this version in even if it's not perfect yet.

Other changes

slightly updated the order of scores in the documentation for default metrics
small correction in the docs for a function

This PR creates an updated vignette for the scoring rules.

Checklist

[x] My PR is based on a package issue and I have explicitly linked it.
[x] I have included the target issue or issues in the PR title as follows: issue-number: PR title
[x] I have tested my changes locally.
[x] I have added or updated unit tests where necessary.
[x] I have updated the documentation if required.
[x] I have built the package locally and run rebuilt docs using roxygen2.
[x] My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
[ ] I have added a news item linked to this PR.
[x] I have reviewed CI checks for this PR and addressed them as far as I am able.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.60%. Comparing base (948f251) to head (0f38601). Report is 2 commits behind head on main.

:exclamation: Current head 0f38601 differs from pull request most recent head 832a420. Consider uploading reports for the commit 832a420 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #762 +/- ## ======================================= Coverage 95.60% 95.60% ======================================= Files 21 21 Lines 1569 1569 ======================================= Hits 1500 1500 Misses 69 69 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nikosbosse commented 4 months ago

@seabbs this is not the best vignette it could be, but I think it makes sense to merge a first version and reiterate.

nikosbosse commented 4 months ago

Thank you! I opened a new issue to address your comments: https://github.com/epiforecasts/scoringutils/issues/785. I currently set it to version 2.1., but feel free to move it to 2.0. if you think we should address this earlier

epiforecasts / scoringutils