Update input formats for binary and point forecasts #460
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…s, update tests for point and binary forecasts
This was referenced Nov 18, 2023
seabbs
reviewed
Nov 20, 2023
There was a problem hiding this comment.
The change is in this PR, but also in #468. I think merging #468 first would be a bit cleaner (I decided midway to try and do things properly by making a separate PR to untangle the fix from the new feature...).
Nothing is stopping you from closing PRs and sorting this out and then reupdating them or even just updating the PR with a note. As a reviewer with limited time this is really quite frustrating practice.
seabbs
approved these changes
Nov 20, 2023
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #460 +/- ##
==========================================
Coverage ? 81.21%
==========================================
Files ? 20
Lines ? 1725
Branches ? 0
==========================================
Hits ? 1401
Misses ? 324
Partials ? 0 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #424, where we discussed that binary and point forecasts so far didn't allow the following inputs:
The first one is very standard behaviour in R so it would be nice to support it and the second one makes the function more consistent with the input formats of e.g. quantile- and sample-based functions, which all expect
predictedto be a matrix.This PR therefore updates the input checks for binary and point forecasts to allow these. It also expands tests to test the new input requirements.
To simplify code, it also creates a new helper function,
check_dims_ok_point()andassert_dims_ok_pointthat checks the dimensions for binary and point forecasts. (In the future we could also do something like that for quantile and sample-based forecasts, I added it to a new issue, #459.I added tests for the point inputs to the binary tests. My reasoning was that tests for binary and point inputs should always be very similar. Having them in one place makes it easier to not forget a test for point that we have for binary and vice versa. And I thought it would be a bit cleaner to have corresponding tests together. The test file for point metrics currently mostly has a few legacy tests from covidHubUtils. I couldn't bring myself to embark on a grand test clean-up right now, but I at least noted it in #346.
Note:
There's a small unrelated change mixed in this PR: see #468. The change was just removing old code remnants that weren't updated due to the same code being changed by 2 PRs:
correlation(),check_metric(), that should not exist anymore after all the updates.scorestoscores_quantilein a failing test that got updated on dev previously, but not in all the branches we merged.The change is in this PR, but also in #468. I think merging #468 first would be a bit cleaner (I decided midway to try and do things properly by making a separate PR to untangle the fix from the new feature...).