Skip to content

Conversation

@mcampos16
Copy link
Contributor

Description

This pull request includes the addition of the tally modifier cumulative_sum. As a part of this addition:

  • The cumulative_sum function includes the option to pass the name of the column to be used for the cumulative sum, but default if 'Value'.
  • The test test_cumulative_sum was implemented in test_manipulate_tally.py. The function is tested both by using the default 'Value' column and a "custom" column name.
  • The tally modifier's name and description was added to JADE's documentation.

No additional dependencies were introduced.

Type of change

Please select what type of change this is.

  • Bug fix (non-breaking change which fixes an issue)
  • New benchmark
    • Non-breaking change which entirely uses existing classes, structure etc
    • Breaking change which has implemented new/modified classes etc
  • New feature
    • Non-breaking change which adds functionality
    • Breaking change fix or feature that would cause existing functionality to not work as expected

Other changes

  • This change requires a documentation update
  • (If Benchmark) This requires additional data that can be obtained from:
    • Benchmark data 1
    • Benchmark data 2

Testing

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Run all the test functions currently available in the tests folder.
  • Added test_cumulative_sum in test_manipulate_tally.py to check the correct operation of the newly added tally modifier.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • General testing
    • New and existing unit tests pass locally with my changes
    • Coverage is >80%

@mcampos16 mcampos16 requested a review from dodu94 September 12, 2025 14:46
@codecov
Copy link

codecov bot commented Sep 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/jade/config/raw_config.py 100.00% <100.00%> (ø)
src/jade/post/manipulate_tally.py 95.90% <100.00%> (+0.07%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@dodu94 dodu94 left a comment

Choose a reason for hiding this comment

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

Perfect, thank you Marta. @alexvalentine94 I'll tag you here for info but the PR is quite simple, no need for double review

@dodu94 dodu94 merged commit 1c19a40 into developing Sep 15, 2025
19 checks passed
@dodu94 dodu94 deleted the add_cumulative_sum branch September 15, 2025 12:30
@mcampos16 mcampos16 mentioned this pull request Oct 2, 2025
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants