Improve variogram docs, deduplicate point implementation, and update vignette#1132
Merged
nikosbosse merged 8 commits intomainfrom Mar 8, 2026
Merged
Improve variogram docs, deduplicate point implementation, and update vignette#1132nikosbosse merged 8 commits intomainfrom
nikosbosse merged 8 commits intomainfrom
Conversation
- Have variogram_score_multivariate_point() delegate to variogram_score_multivariate() with w = NULL instead of reimplementing the same loop - Use @inheritParams and @inherit to consolidate roxygen docs across the sample and point variogram functions - Improve parameter docs for w (fix dat -> predicted reference), w_vs (explain pairwise weighting), and p - Add proper descriptions, @return, and @references to energy_score_multivariate() - Fix energy score keyword from internal_input_check to metric Closes #1118, closes #1124 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1132 +/- ##
==========================================
- Coverage 97.95% 97.94% -0.01%
==========================================
Files 37 37
Lines 1955 1951 -4
==========================================
- Hits 1915 1911 -4
Misses 40 40 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Add section on variogram score alongside energy score with explanation of what each measures - Show how to customise variogram parameters via purrr::partial() - Add multivariate point forecast section using as_forecast_multivariate_point() - Add variogram score examples to the matrix-based section, including weight matrix (w_vs) and order parameter (p) Closes #1116 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 tasks
- Explain what the variogram score measures in concrete terms (pairwise differences between targets, not abstract dimensions) - Improve p parameter docs to explain how it scales differences - Use "targets" instead of "dimensions" throughout for clarity - Add note on p parameter and link to docs in vignette Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Explain what the score measures in concrete terms (pairwise differences between targets, not abstract dimensions) - Improve p parameter docs to explain how it scales differences - Use "targets" instead of "dimensions" throughout for clarity Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The section compared scoringutils wrappers against raw scoringRules calls, which is an implementation detail that doesn't help users. The vignette now focuses on the scoringutils API via score(). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
seabbs-bot
changed the title
seabbs
approved these changes
Mar 5, 2026
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
seabbs
reviewed
Mar 5, 2026
Contributor
seabbs
left a comment
seabbs
left a comment
There was a problem hiding this comment.
Note I got rid of the matrix tests in the vignette vs scoringRules as we don't have it for other forecast types and it didn't seem like it was adding much
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Code deduplication (#1118)
variogram_score_multivariate_point()now delegates tovariogram_score_multivariate()withw = NULLinstead of reimplementing the same vapply loopDocumentation improvements (#1124)
@inheritParamsand@inheritacross sample and point variogram functionsw(fixeddat→predictedreference from scoringRules),w_vs(explains pairwise weighting between targets), andp(explains how it scales differences)energy_score_multivariate()now has a proper description,@return,@references, and@keywords metric(wasinternal_input_check)Vignette update (#1116)
as_forecast_multivariate_point()purrr::partial()(e.g.p = 1)Test plan
Closes #1118, closes #1124, closes #1116
This was opened by a bot. Please ping @seabbs for any questions.