Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Add more documentation + print method for default metrics #365

Closed
nikosbosse opened this issue Oct 27, 2023 · 2 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@nikosbosse
Copy link
Contributor

There are now some default metrics stored as a list.
These need more documentation. Some ideas:

  • Add them to a vignette
  • Add documentation to score()
  • Create an attribute with some explanations, make the stored objects belong to some class like scoringutils_metrics() and create a new print method for it.
  • Create a new data.frame that lists all the metrics and store them as an object in scoringutils
@nikosbosse nikosbosse converted this from a draft issue Oct 27, 2023
@nikosbosse nikosbosse added documentation Improvements or additions to documentation next-release labels Oct 27, 2023
@nikosbosse nikosbosse added this to the scoringutils 1.3 milestone Oct 27, 2023
@seabbs
Copy link
Contributor

seabbs commented Oct 30, 2023

e stored objects belong to some class like scoringutils_metrics(

This seems like it could be a good idea?

@nikosbosse nikosbosse changed the title Add more documentation for default metrics Documentation: Add more documentation + print method for default metrics Nov 15, 2023
This was referenced Nov 23, 2023
@nikosbosse
Copy link
Contributor Author

As mentioned in #415:

The default scoring rules for every forecast type are documented in the rules_*() function documentation which links to all individual functions. In addition, users should be able to find more information in the Vignette.

I think we don't necessarily need additional documentation beyond this. Creating a print method with additional information from the docs seems like something that's not really useful + hard to maintain. I'm therefore closing this for now, but please reopen if you disagree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

2 participants