Thanks in part to helpful rOpenSci editor comments (ropensci/software-review#674) this release makes some improvements to the package, making it more suitable for the rOpenSci software review process, which will be based on this new release going forward.
- The package name has changed from browseMetadata to mapmetadata. mapmetadata better reflects the function of this package and complies with formatting best practice for R package naming
- Combined the browse function into the map function to simplify package use for the user
- Changed some function names to match object_verb convention
- Now using csv (not json) as the the metadata input to reflect the new structure from Health Data Research Gateway
- Removed some custom functions, because utils already offered these! (or very similar)
- Clearer and more detailed user documentation in README and package website
- Logo has been replaced to reflect new package name
- Updated DESCRIPTION file to directly mention Health Data Research Gateway as a data source for this package, normalised the DESCRIPTION file formatting
- Open up the html output file automatically in the user's browser, insteading of prompting the user to do this manually
- Internal functions no longer listed on the package website, only user functions
- Handle temp directories better in unit tests, by using
withr::local_tempdir() - Improved unit tests by using
testthat::local_mocked_bindings
🥳 Submitted this release to rOpenSci: ropensci/software-review#674
- Addition of pkgcheck workflow
- Added more units test to get the code coverage to exceed minimum standard (>75%)
- Added bug fix location to DESCRIPTION
- Added pkgcheck workflow badge to README
- Inidicated internal functions by using @internal tag
- Simplified the pkgdown file using the internal tag
- Updated pull request template
- Added examples to functions that did not have them