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

Create documentation on registering a data source #57

Open
1 task
Tracked by #294
kzollove opened this issue Sep 9, 2022 · 2 comments
Open
1 task
Tracked by #294

Create documentation on registering a data source #57

kzollove opened this issue Sep 9, 2022 · 2 comments
Labels
documentation Requires (re) writing of documentation, no coding. SQL Pertinent to the database

Comments

@kzollove
Copy link
Collaborator

kzollove commented Sep 9, 2022

Data sources must be registered in the Postgres backbone.data_source table to be used within this framework. Registering can be a confusing, complex task depending on the complexity of the source dataset.

This documentation should probably be created as a vignette in the R package.

This documentation should give a thorough explanation of each column in the data source (geom_spec in particular) and walk a potential user through the process of creating a row in the table, updating the DDL for the backbone schema, and creating a PR for the new DDL.

Depends on

@kzollove kzollove added documentation Requires (re) writing of documentation, no coding. SQL Pertinent to the database labels Sep 9, 2022
@kzollove kzollove added this to the v0.2.0 milestone Sep 9, 2022
@kzollove
Copy link
Collaborator Author

kzollove commented Sep 9, 2022

This introduces the need for a framework for handling new data sources/ features. While a later iteration of this work will likely have an API built around the database to facilitate data source creation and persistence, for now we should have a robust method for requesting and accepting new data sources and features.

@kzollove
Copy link
Collaborator Author

Make sure that there is a part of this documentation that addresses how to create data_sources for offline use (use of download_url is different)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires (re) writing of documentation, no coding. SQL Pertinent to the database
Projects
Status: 🏷TODO
Development

No branches or pull requests

1 participant