epiforecasts / scoringutils

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

Rename pairwise comparisons #722

Closed nikosbosse closed 7 months ago

nikosbosse commented 7 months ago

Description

As discussed in #638, this PR

The rationale for this change is this:

Visualisation of mean score ratios:

image

Checklist

codecov[bot] commented 7 months ago

Codecov Report

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

Project coverage is 95.27%. Comparing base (0982955) to head (004b1f3).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #722 +/- ## ======================================= Coverage 95.27% 95.27% ======================================= Files 21 21 Lines 1630 1630 ======================================= Hits 1553 1553 Misses 77 77 ```

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

seabbs commented 7 months ago

plot_pairwise_comparisons()

For this little one shall we just chuck in an alias? It seems a bit cruel! Or shall we just be cruel?

nikosbosse commented 7 months ago

Maybe we should just be cruel? I don't know, the downside to aliases that I see is that they clutter the docs and the autocomplete dropdown

nikosbosse commented 7 months ago

Dear future user, if you're reading this and are upset: we apologise for our cruelty. Please blame it on me and only me. I think the change is a bit annoying, but you're code is going to break anyways, regardless of whether we keep the s or not. So we might as well break everything hard this time.. But happy to open an issue if we think it's useful.