Clarify the halfwidth mean-error difference sign#457
Open
Kkkakania wants to merge 2 commits into
Open
Conversation
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
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.
Description
Clarifies the sign convention behind the difference returned by halfwidth_ci_test.
The function consistently returns score(forecasts2) - score(forecasts1), but each score follows the selected metric argument convention. For mean error, xskillscore defines me(a, b) as mean(a - b) and halfwidth_ci_test calls it as me(observations, forecast). The resulting sign is therefore opposite to calculations that define error as forecast - observation. The sign does not change the significance decision because that comparison uses the absolute difference.
This documents the behavior reported in #413 without changing the existing statistical calculation.
Closes #413
Type of change
How Has This Been Tested?
Checklist (while developing)
Pre-Merge Checklist (final steps)