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

Documentation for required components in loading entities #584

Open
gsantia opened this issue Mar 9, 2021 · 0 comments
Open

Documentation for required components in loading entities #584

gsantia opened this issue Mar 9, 2021 · 0 comments
Assignees
Labels
documentation Regarding developer or user documentation

Comments

@gsantia
Copy link
Contributor

gsantia commented Mar 9, 2021

When working with the load stage in isolation it took some time to get the data I wanted to be loaded into the standardized form. I was working off of the Data Service documentation, which not only seems to be incorrect sometimes, but can lead to ambiguities. For example, which type of ID is really needed when it refers to an entity ID attribute (external or kf_id)? Or, how exactly should the values be formatted (such as with genomic-file.hash, there's no indication given). Another concern here is having to take entities found in the Data Service and find their appropriate counterparts in the concepts.py file.

The Kids First Data Service target API plugin .py file is much more precise in what attributes are required for each entity using the load stage. But checking this file wasn't immediately apparent to me, and it might be better to have this information in a more user-friendly format in the documentation. Not only would this make using the load stage in isolation more straight-forward, but I could see it making using the ingest library easier for people not already familiar with it.

This could also be interpreted as an issue with the Data Service documentation. I know that the ingest library is designed for use with multiple target API plugins.

@gsantia gsantia added the documentation Regarding developer or user documentation label Mar 9, 2021
@gsantia gsantia self-assigned this Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Regarding developer or user documentation
Projects
None yet
Development

No branches or pull requests

1 participant