-
Notifications
You must be signed in to change notification settings - Fork 12
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 #167
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## v1.0-main #167 +/- ##
=============================================
+ Coverage 90.12% 90.89% +0.77%
=============================================
Files 14 14
Lines 1752 1802 +50
=============================================
+ Hits 1579 1638 +59
+ Misses 173 164 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
anthonysena
added a commit
that referenced
this pull request
Oct 7, 2024
* Add functions to expose rdms for each module and test * Create full data model SQL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Aims to address #143 through the following changes:
getResultsDataModelSpecification
function to the StrategusModule base class. Each module then implements this method to provide the results data model specification so that we can construct the full results data model for all modules in Strategus.extras/DocumentResultsDataModel.R
to construct SQL used to document the results data model. At the moment this full results model is kept in theextras
folder. We might consider exposing this as a package function so we can version the results data model for a given release of Strategus as described by @schuemie on our recent HADES Strategus WG call..github/workflows/pkgdown.yaml
to automatically document the package usingpkgdown
when publishing to themain
branch..github/workflows/pkgdown.yaml
workflow to include the steps to run SchemaSpy on a PG instance set up during the GHA workflow to document the results data model. Credit to https://blog.devops.dev/generate-db-documentation-and-deploy-in-github-4ef7a3132401.Additional work required:
extras/rdms/schema_meta.xml
gh-pages
branch of this repo so when Strategus v1.0 is released, I need to update the repo configuration.