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

Formalize handling and reporting of input errors #128

Merged
merged 27 commits into from
Jan 17, 2024

Conversation

ielis
Copy link
Member

@ielis ielis commented Jan 11, 2024

Create an Auditor API to formalize recording and reporting errors in the input data, while preserving the context of the hierarchical data.

Auditor is implemented on the following APIs:

  • PhenotypeCreator
  • PatientCreator
  • CohortCreator

Note, we introduce CohortCreator as the top-level API for creating cohort e.g. from a phenopacket folder. We provide a new convenience method for configuring the cohort creator:

from genophenocorr.preprocessing import configure_caching_cohort_creator

The errors and warnings are handled depending on the validation policy. See the docs for more info.

fixes #56
fixes #120
fixes #84
fixes #113
fixes #79

@ielis ielis marked this pull request as ready for review January 11, 2024 18:25
@ielis ielis changed the title Handle phenotype creator errors Formalize handling and reporting of input errors Jan 16, 2024
@ielis
Copy link
Member Author

ielis commented Jan 16, 2024

@lnrekerle please have a look, please check the notebooks as we discussed, and give it a 👍 if looks good.

Copy link
Collaborator

@lnrekerle lnrekerle left a comment

Choose a reason for hiding this comment

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

Sorry this took me a bit to get to, but looks good!

@ielis ielis merged commit eb19b89 into develop Jan 17, 2024
5 checks passed
@ielis ielis deleted the handle-phenotype-creator-errors branch January 19, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment