Discussion: Which pkgdown function categories do we want to have?

[nikosbosse]

https://epiforecasts.io/scoringutils/reference/index.html has a nice overview of all functions. All functions are tagged with a keyword and then get a category with a certain heading.

What should the headings / categories be?

What we have at the moment

(from _pkgdown.yaml)

title: Package documentation
          contents:
                - scoringutils
        - title: Functions to check and analyse inputs
          contents:
                - has_keyword("check-forecasts")
        - title: Functions for convenient forecast evaluation
          contents:
                - score
                - has_keyword("scoring")
                - starts_with("score_")
        - title: Lower-level scoring functions
          contents:
                - has_keyword("metric")
        - title: Data wrangling helpers
          contents:
                - has_keyword("data-handling")
        - title: Functions for plotting and data visualisation
          contents:
                - starts_with("plot_")
                - has_keyword("plotting")
        - title: Internal functions
          contents:
                - has_keyword("internal")
        - title: Example data and information
          contents:
                - has_keyword("datasets")
                - has_keyword("info")

Questions

• We definitely need to make small updates to the keywords, e.g. starts_with("score_") needs to go
• The current setup doesn't quite reflect functions such as
  • add_coverage()
  • I'm also a bit unsure what add_pairwise_comparison() would be...
  • or the get_ functions that provide more information
  • run_safely()
• Adding subtitles would be also nice to structure the internal functions a bit, e.g. input checks, other internal functions etc. Also distinguishing test functions from check functions etc. would be nice.

[seabbs]

We should organise this based on your workflow figures? With the main functions all together?