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 YAML-based threshold input options for find_outliers #13

Merged
merged 2 commits into from
May 21, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented May 20, 2024

Description

This PR adds the ability to receive YAML-based threshold sets as input to be used by find_outliers as part of #4 . I tried to keep this simpler than what is defined in the later comments of the issue, observing YAGNI (we don't yet understand the requirements for different types of thresholds, for example).

Thanks for any feedback you may have!

Closes #4

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • 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 and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs requested a review from jenna-tomkinson May 20, 2024 16:10
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

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

I am leaving a comment for now as I am curious your responses to my comments. I want to clarify how the function will work if the yaml file is provided. Will it read in one condition at a time and output a df per condition or how will it work?

Please let me know when to re-review!

src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/data/qc_thresholds_default.yml Outdated Show resolved Hide resolved
Co-Authored-By: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>
@d33bs
Copy link
Member Author

d33bs commented May 20, 2024

Thanks @jenna-tomkinson for the review! I responded to your comments and feel this is ready for a re-review.

@d33bs d33bs requested a review from jenna-tomkinson May 20, 2024 22:37
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

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

LGTM! 🎉

@d33bs
Copy link
Member Author

d33bs commented May 21, 2024

Thanks @jenna-tomkinson ! Merging this in. I'm in-progress with efforts on #10 as a next step.

@d33bs d33bs merged commit 6f5fed8 into WayScience:main May 21, 2024
11 checks passed
@d33bs d33bs deleted the config-files branch May 21, 2024 23:00
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.

Add capabilities to receive and use sets of QC rules (default and customizable)
2 participants