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

Document results data model for modules #143

Closed
anthonysena opened this issue Jul 1, 2024 · 2 comments · Fixed by #167
Closed

Document results data model for modules #143

anthonysena opened this issue Jul 1, 2024 · 2 comments · Fixed by #167
Milestone

Comments

@anthonysena
Copy link
Collaborator

Related to #43, Strategus & its modules should be capable of producing documentation that fully describes the results data model. A good example of this was created by @msuchard during the SOS Challenge here: https://github.com/ohdsi-studies/FluoroquinoloneAorticAneurysm/blob/master/docs/StrategusDataModel.html.

Presuming all modules adopt the RMM package for describing & managing the results schema, perhaps this type of functionality should be supported via RMM and exposed via Strategus?

Tagging @azimov for thoughts on this.

@anthonysena
Copy link
Collaborator Author

Noting that @msuchard put together a nice document here that outlines the results data model. I'd like to make this type of artifact a part of each Strategus release to help developers working with the results data model.

@anthonysena
Copy link
Collaborator Author

Adding some notes based on the work done in #167 to document the results data model:

  • Using SchemaSpy to auto-generate the results data model documentation which will reside with the Strategus documentation.
  • Adopted the pkgdown workflow to automatically publish the package documentation & results data model specifications upon a release of Strategus.
  • The script for updating the results data model documentation is found in extras/DocumentResultsDataModel.R.
  • Table descriptions are stored in extras/rdms/table_descriptions.csv and this file is maintained manually.
  • Results table relationships (i.e. foreign keys) are stored in extras/rdms/results_table_relationships.csv. This file is maintained manually. The initial version of this file was developed by extracting the SQL from the OhdsiShinyModules repo to determine the relationships between tables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant