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

Fine-grained tests for herg QC #23

Merged
merged 36 commits into from
Dec 12, 2024
Merged

Fine-grained tests for herg QC #23

merged 36 commits into from
Dec 12, 2024

Conversation

kwabenantim
Copy link
Member

@kwabenantim kwabenantim commented Aug 8, 2024

Description

Supports #21

  • Each QC check (qc_1(), qc_2(), etc.) now returns (bool, value) tuples indicating pass/fail and the checked value.
  • hERGQC.run_qc() now returns a QCDict object which contains the results from all QC checks.
    • QCDict.all_passed() returns a bool for whether all checks passed.
    • QCDict.passed_list() returns a list of bools, one for each check.
    • QCDict.qc_passed(label) returns a bool for a specific check.
  • Each QC is now tested on all wells, with a list of known failing wells for each check.
  • Each QC check is also tested with artificial data.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Testing

  • Testing is done automatically and codecov shows test coverage
  • This cannot be tested automatically

Documentation checklist

  • I have updated all documentation in the code where necessary.
  • I have checked spelling in all (new) comments and documentation.
  • I have added a note to RELEASE.md if relevant (new feature, breaking change, or notable bug fix).

@kwabenantim kwabenantim self-assigned this Aug 8, 2024
@kwabenantim kwabenantim added the enhancement New feature or request label Aug 8, 2024
@kwabenantim kwabenantim linked an issue Aug 8, 2024 that may be closed by this pull request
@kwabenantim kwabenantim marked this pull request as ready for review August 12, 2024 13:43
@kwabenantim kwabenantim changed the title Fine-grained tests for herg QC Fine-grained test outputs for herg QC Aug 12, 2024
@kwabenantim kwabenantim changed the title Fine-grained test outputs for herg QC Fine-grained tests for herg QC Aug 12, 2024
Copy link

codecov bot commented Nov 28, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@joeyshuttleworth
Copy link
Collaborator

joeyshuttleworth commented Nov 29, 2024

Would it be possible/worth it to rewrite QCDict so that it inherits from UserDict? It seems like we're replicating a few basic dictionary functions. It might not be worth the effort, but if it's simple to do it might simplify the code a little bit

@hilaryh hilaryh merged commit e6085a6 into main Dec 12, 2024
7 checks passed
@hilaryh hilaryh deleted the 21-fine-grained-testing branch December 12, 2024 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lower level unit tests for every QC criterion
4 participants