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

Discuss package structure and improve API reference #36

Closed
ielis opened this issue Sep 5, 2023 · 0 comments · Fixed by #38
Closed

Discuss package structure and improve API reference #36

ielis opened this issue Sep 5, 2023 · 0 comments · Fixed by #38

Comments

@ielis
Copy link
Member

ielis commented Sep 5, 2023

We need to discuss the API of the library. Things like:

  • pros and cons of keeping all data/value definitions in a single package (e.g. genophenocorr.model)
  • creating a package with code for taking input data, such as phenopackets, Phenopacket Schema Cohort, and turn it into the internal representation. This includes the code for variant/protein annotation, basically everything we need to do before we get genophenocorr.Cohort. My suggestion is to put the code into genophenocorr.preprocess.

When we're happy with the package structure, we can setup the __init__.py files to play with make doctest and enable generation of the API reference documentation sections.

@ielis ielis linked a pull request Sep 11, 2023 that will close this issue
@ielis ielis closed this as completed Sep 14, 2023
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 a pull request may close this issue.

1 participant