Skip to content

Add tests for combination logic with inclusion and washout periods in… - #157

Open
kirilklein wants to merge 1 commit into
mainfrom
tests/test_outcomes_combination
Open

Add tests for combination logic with inclusion and washout periods in…#157
kirilklein wants to merge 1 commit into
mainfrom
tests/test_outcomes_combination

Conversation

@kirilklein

@kirilklein kirilklein commented Aug 6, 2025

Copy link
Copy Markdown
Owner

… OutcomeMaker

  • Introduced new test cases to validate the inclusion flag functionality for event combinations, ensuring correct outcomes based on specified time windows.
  • Implemented a test for washout periods to confirm that only the first occurrence of an event is captured when subsequent events occur within a defined timeframe.
  • Enhanced test coverage for the OutcomeMaker to ensure robust handling of complex event scenarios.

Summary by CodeRabbit

  • Tests
    • Added tests to verify correct handling of combination outcomes with inclusion and exclusion flags, including scenarios for event inclusion based on time windows and washout periods.

… OutcomeMaker

* Introduced new test cases to validate the inclusion flag functionality for event combinations, ensuring correct outcomes based on specified time windows.
* Implemented a test for washout periods to confirm that only the first occurrence of an event is captured when subsequent events occur within a defined timeframe.
* Enhanced test coverage for the OutcomeMaker to ensure robust handling of complex event scenarios.
@coderabbitai

coderabbitai Bot commented Aug 6, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Two new test methods were added to the TestOutcomeMaker test suite. These tests verify the behavior of combination outcomes with inclusion and exclusion flags, specifically for scenarios involving myocardial infarction followed by death and for stroke events with a washout period. The tests assert correct event filtering based on the defined logic.

Changes

Cohort / File(s) Change Summary
TestOutcomeMaker - Combination Outcome Tests
tests/test_modules/test_outcomemaker.py
Added two test methods: one for inclusion flag behavior in combination outcomes, and one for exclusion (washout) logic in combination outcomes.

Sequence Diagram(s)

sequenceDiagram
    participant Test as TestOutcomeMaker
    participant OutcomeMaker as OutcomeMaker
    participant Data as Test Data
    participant CSV as Output CSV

    Test->>OutcomeMaker: Define combination outcome (with include/exclude)
    OutcomeMaker->>Data: Run outcome logic on test data
    OutcomeMaker->>CSV: Write filtered results to CSV
    Test->>CSV: Read CSV results
    Test->>Test: Assert correctness of filtered events
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • feat: outcomemaker exclusion handling #145: Implements and tests exclusion handling logic in the OutcomeMaker class, closely related to the new combination outcome tests.
  • Merge/may1 #67: Introduces combination outcome definitions and matching logic, directly connected to the test scenarios in this PR.

Poem

In the warren of tests, two new paths appear,
Outcomes combining, their logic now clear.
Exclusion and washout, inclusion in tow,
Rabbits hop forward, ensuring code flow.
With every assertion, our confidence grows—
For robust results, the carrot bellows! 🥕

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch tests/test_outcomes_combination

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/test_modules/test_outcomemaker.py (1)

1-773: Fix code formatting to pass CI checks.

The pipeline indicates formatting issues that need to be addressed.

Run the following command to fix the formatting:

ruff format tests/test_modules/test_outcomemaker.py
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2862ad and f81bd3a.

📒 Files selected for processing (1)
  • tests/test_modules/test_outcomemaker.py (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: kirilklein
PR: kirilklein/PHAIR_EHR#108
File: tests/test_main_causal/test_helper/test_select_cohort.py:39-43
Timestamp: 2025-06-07T13:06:20.414Z
Learning: When analyzing time window calculations in tests, be more careful with date arithmetic. Patient 3 with index date 2019-06-15 and data_end 2020-12-31 has approximately 565 days of follow-up, which exceeds the 365-day minimum requirement.
🪛 GitHub Actions: Format
tests/test_modules/test_outcomemaker.py

[error] 1-1: ruff formatting check failed. File would be reformatted. Run 'ruff format' to fix code style issues.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: pipeline_tests_performance
  • GitHub Check: pipeline_tests
  • GitHub Check: tests
  • GitHub Check: Docstring Coverage
  • GitHub Check: tests
  • GitHub Check: tests
  • GitHub Check: tests
  • GitHub Check: unittests
  • GitHub Check: test
  • GitHub Check: tests
  • GitHub Check: Test Coverage
🔇 Additional comments (2)
tests/test_modules/test_outcomemaker.py (2)

701-734: LGTM! Well-structured test for inclusion flag behavior.

The test correctly validates the default inclusion behavior (exclude: false) for combination outcomes. The assertion logic properly expects patients 4 and 8 to be included (death within 7 days of MI) while excluding patient 9 (death 8 days after MI).


735-768: Excellent implementation of washout period logic!

This test demonstrates an innovative use of the combination framework to implement washout periods. The logic correctly identifies first occurrences by excluding events that have prior occurrences within the specified timeframe. The test setup and assertions properly validate that Patient 6's first stroke and Patient 7's single stroke are included, while Patient 6's second stroke is excluded due to the washout period.

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.

1 participant