Skip to content

Improvements to avail_forecasts() --> available_forecasts()#321

Merged
nikosbosse merged 9 commits intoscoringutils-reviewfrom
scoringutils-review4
Sep 5, 2023
Merged

Improvements to avail_forecasts() --> available_forecasts()#321
nikosbosse merged 9 commits intoscoringutils-reviewfrom
scoringutils-review4

Conversation

@nikosbosse
Copy link
Copy Markdown
Collaborator

@nikosbosse nikosbosse commented Sep 3, 2023

This PR addresses one of the issues raised by a recent review of the package as part of a submission to the Journal of Statistical Software (JSS).

It

  • renames the function avail_forecasts() to available_forecasts() for consistency with available_metrics(). The old function, avail_forecasts() is still available as an alias, but will be removed in the future.
  • renames one of the output column in avail_forecasts() from "Number forecasts" to "count".
  • changes available_forecasts() to display combinations where there are 0 forecasts, instead of silently dropping corresponding rows.
  • creates an S3 method plot() that replaces plot_avail_forecasts(). The old function is still available, but is deprecated.

I think the suggestion to include combinations with 0 forecasts is a good one as it makes it very clear that no forecasts are available and users can always drop those rows afterwards.

Copy link
Copy Markdown
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree this looks good.

@nikosbosse nikosbosse merged commit db55a1d into scoringutils-review Sep 5, 2023
@nikosbosse nikosbosse deleted the scoringutils-review4 branch September 5, 2023 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants