Update the README following major changes to the import process. #95
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
The README makes mention of a database that gets created at startup from the imported data. This step was removed as part of PR #72. The imported data is now used directly by mintr, and no database needs construction. Also some minor related updates here and there: - The data files are now hosted on GitHub releases rather than DIDE servers. - The `inst/version` file was renamed to `inst/data_version` in #94. - The .gitignore contained an `import` line which matched against `scripts/import`. While git supports this fine, other tooling gets confused a bit. As far as I can tell, there are no scripts that produce files with that name (anymore at least). - `scripts/import` contained an old `import` function that was used to feed the data to tests. The `mintr_test_db_init` is now responsible for that task and gets called automatically. - The branch for #72 was temporarily added to CI config files. This isn't needed anymore now that work on this is complete.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #95 +/- ##
=======================================
Coverage 99.71% 99.71%
=======================================
Files 7 7
Lines 356 356
=======================================
Hits 355 355
Misses 1 1 ☔ View full report in Codecov by Sentry. |
richfitz
approved these changes
Dec 7, 2023
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.
The README makes mention of a database that gets created at startup from the imported data. This step was removed as part of PR #72. The imported data is now used directly by mintr, and no database needs construction.
Also some minor related updates here and there:
inst/versionfile was renamed toinst/data_versionin mrc-4163 version endpoint #94.importline which matched againstscripts/import. While git supports this fine, other tooling gets confused a bit. As far as I can tell, there are no scripts that produce files with that name (anymore at least).scripts/importcontained an oldimportfunction that was used to feed the data to tests. Themintr_test_db_initis now responsible for that task and gets called automatically.