changes US spelling to UK spelling for consistency with the rest of the documentation.
slightly reformatted the function documentation
exports the alias function customize_metrics() which was previously internal.
updates the documentation of the metrics and ... arguments in score() to make clear how passing an argument to a scoring rule should work.
makes the documentation of customise_metrics() more verbose and adds an additional example of how to pass additional arguments to a function used in score().
updates the documentation for the internal apply_metrics() function to explain that we're currently not making use of the ... argument in apply_metrics().
adds a few tests - mostly I ran those to get familiar with the change and thought it wouldn't harm to include them.
corrects a test by changing count_median_twice from TRUE to FALSE. Added a new test to test for that behaviour explicitly.
updates another test to add the separate_results = FALSE arg back in.
Checklist
[x] My PR is based on a package issue and I have explicitly linked it.
[x] I have included the target issue or issues in the PR title as follows: issue-number: PR title
[x] I have tested my changes locally.
[x] I have added or updated unit tests where necessary.
[x] I have updated the documentation if required.
[x] I have built the package locally and run rebuilt docs using roxygen2.
[x] My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
[ ] I have added a news item linked to this PR.
[x] I have reviewed CI checks for this PR and addressed them as far as I am able.
Description
This PR
customize_metrics()which was previously internal.metricsand...arguments inscore()to make clear how passing an argument to a scoring rule should work.customise_metrics()more verbose and adds an additional example of how to pass additional arguments to a function used inscore().apply_metrics()function to explain that we're currently not making use of the...argument inapply_metrics().count_median_twicefromTRUEtoFALSE. Added a new test to test for that behaviour explicitly.separate_results = FALSEarg back in.Checklist
lintr::lint_package()to check for style issues introduced by my changes.