Implemented spearman's correlationship - Githubissues

nci / scores

scores: Metrics for the verification, evaluation and optimisation of forecasts, predictions or models.

https://scores.readthedocs.io/

Apache License 2.0

76 stars 25 forks source link

Implemented spearman's correlationship #773

Open lbluett opened 16 hours ago

lbluett commented 16 hours ago

Implementation of Spearman's correlation from #313 I've added an example notebook based off of the Pearson's notebook.

Development for new xarray-based metrics

[X] Works with n-dimensional data and includes reduce_dims, preserve_dims, and weights args.
[X] Typehints added
[ ] Add error handling
[?] Imported into the API
[X] Works with both xr.DataArrays and xr.Datasets if possible

Docstrings

[X] Docstrings complete and follow Napoleon (google) style
[X] Maths equation added
[X] Reference to paper/webpage is in docstring. The preferred referencing style for journal articles is APA (7th edition)
[X] Code example added

Testing of new xarray-based metrics

[ ] 100% unit test coverage
[ ] Test that metric is compatible with dask.
[ ] Test that metrics work with inputs that contain NaNs
[ ] Test that broadcasting with xarray works
[ ] Test both reduce and preserve dims arguments work
[ ] Test that errors are raised as expected
[ ] Test that it works with both xr.DataArrays and xr.Datasets

Tutorial notebook

[X] Short introduction to why you would use that metric and what it tells you
[X] A link to a reference
[X] A "things to try next" section at the end
[X] Add notebook to Tutorial_Gallery.ipynb
[X] Optional - a detailed discussion of how the metric works at the end of the notebook

Documentation

[?] Add the score to the API documentation
[?] Add the score to the included list of metrics and tools

tennlee commented 7 hours ago

I have already spoken to @lbluett during the sprints about the need to add tests.