Skip to content
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.

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

Add sustainability score for simplified understanding through single metric #208

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Dec 16, 2024

Description

This PR adds a "sustainability score" metric which summarizes the findings of other metrics in one single value. This score is calculated using boolean metrics and a "sustainability direction" value per metric. The values are summed and divided by the number of metrics to then provide a score.

Along the journey towards this PR I noticed and fixed the following:

  • Metrics types and type check tests for the metrics table (which presented challenges earlier and benefited the work in this PR).

Closes #135
Closes #207

What is the nature of your change?

  • Content additions or updates (adds or updates content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own contributions.
  • I have commented my content, particularly in hard-to-understand areas.
  • I have made corresponding changes to related documentation (outside of book content).
  • My changes generate no new warnings.
  • New and existing tests pass locally with my changes.
  • I have added tests that prove my additions are effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review December 16, 2024 12:58
Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

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

Several discussion points this time

src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/data.py Outdated Show resolved Hide resolved
src/almanack/metrics/metrics.yml Outdated Show resolved Hide resolved
src/almanack/metrics/metrics.yml Outdated Show resolved Hide resolved
d33bs and others added 9 commits December 22, 2024 20:48
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Co-authored-by: Gregory Way <gregory.way@gmail.com>
d33bs and others added 2 commits December 22, 2024 21:52
Co-Authored-By: Gregory Way <gregory.way@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants