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

[IBCDPE-983] Updates GX functionality to surface warnings #161

Merged
merged 15 commits into from
Dec 9, 2024

Conversation

BWMac
Copy link
Contributor

@BWMac BWMac commented Dec 4, 2024

Description:

For the purposes of this project, "warnings" refer to messages raised following GX data validation informing us about fields which have some values that fail an expectation, but which still meet the threshold set by the GX mostly parameter.

This PR adds logic and does some refactoring in the GreatExpectationsRunner class and elsewhere to surface these warnings along with any failures. An example of what this looks like in the GX report table on Synapse can bee seen here. In this example, I have also intentionally added a bad genes_biodomains file so we can see what it looks like when there are failures and warnings. This second example shows what it looks like with warnings only, which is what we expect now using mostly in the gene_info and network datasets.

Notes:

  • The mostly parameter was added to three expectations as requested here, but I was unsure of what to set the value to (since they were all passing at 100%, I started with mostly=0.95). Please let me know if this should change.
  • Updated unit tests and test assets as needed.
  • Added some info about the mostly parameter and its usage in this package in CONTRIBUTING.md
    • Bumped synapseclient version up to 4.4.1. This is the last stable version that supports Python 3.8, so until we deprecate support for 3.8 in agora-data-tools we can no longer upgrade synapseclient versions.

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@BWMac BWMac marked this pull request as ready for review December 5, 2024 19:31
@BWMac BWMac requested a review from a team as a code owner December 5, 2024 19:31
Copy link
Contributor

@jaclynbeck-sage jaclynbeck-sage left a comment

Choose a reason for hiding this comment

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

Looks good!

setup.cfg Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Dec 6, 2024

@BWMac BWMac merged commit 17485f6 into dev Dec 9, 2024
10 checks passed
@BWMac BWMac deleted the bwmac/IBCDPE-983/gx-mostly branch December 9, 2024 14:56
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