8000 Add arxiv reference to risk matrix score by rob-taggart · Pull Request #827 · nci/scores · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add arxiv reference to risk matrix score #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Feb 18, 2025
Merged

Add arxiv reference to risk matrix score #827

merged 6 commits into from
Feb 18, 2025

Conversation

rob-taggart
Copy link
Collaborator
@rob-taggart rob-taggart commented Feb 14, 2025 •
edited
Loading

Please work through the following checklists. Delete anything that isn't relevant.

Development for new xarray-based metrics

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

Docstrings

  • Docstrings complete and follow Napoleon (google) style
  • Maths equation added
  • Reference to paper/webpage is in docstring. The preferred referencing style for journal articles is APA (7th edition)
  • 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

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

Documentation

@rob-taggart
Update risk_matrix.py
b1ffa72 
added arxiv reference

Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart
Update Risk_Matrix_Score.ipynb
bc6f2db 
added arxiv reference

Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart
Update included.md
3741d1d 
added arxiv reference

Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart rob-taggart linked an issue Feb 14, 2025 that may be closed by this pull request
add arxiv reference to risk matrix score #826
Closed
@rob-taggart
Copy link
Collaborator Author

@nicholasloveday , I've updated references to the risk matrix score paper on arxiv. Should be easy to review and approve

nicholasloveday
nicholasloveday approved these changes Feb 14, 2025
View reviewed changes
Copy link
Collaborator
@nicholasloveday nicholasloveday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tennlee this looks good to me. I suggest that it is merged

Steph-Chong
Steph-Chong reviewed Feb 14, 2025
View reviewed changes
Copy link
Collaborator
@Steph-Chong Steph-Chong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor feedback about the reference formatting.

@rob-taggart
Update risk_matrix.py
01db84e 
added arXiv to references

Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart
Update included.md
bd07ab4 
Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart
Update Risk_Matrix_Score.ipynb
7d34f12 
Signed-off-by: rob-taggart <83570124+rob-taggart@users.noreply.github.com>
@rob-taggart
Copy link
Collaborator Author

@Steph-Chong , I've made the changes you suggested.
@tennlee , hopefully ready to be merged in now

@tennlee tennlee changed the title 826 add arxiv reference to risk matrix score Add arxiv reference to risk matrix score Feb 18, 2025
@tennlee tennlee merged commit 8d8b139 into develop Feb 18, 2025
19 checks passed
@tennlee tennlee deleted the 826-add-arxiv-reference-to-risk-matrix-score branch February 18, 2025 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Steph-Chong Steph-Chong Steph-Chong left review comments

@nicholasloveday nicholasloveday nicholasloveday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

add arxiv reference to risk matrix score
4 participants
@rob-taggart @nicholasloveday @Steph-Chong @tennlee
0