Skip to content

Commit

Permalink
Update NEWS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RayStick authored Jan 6, 2025
1 parent 3e25495 commit 329bd92
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
mapmetadata 3.0.0 (2025-01-06)
=========================

Thanks in part to helpful rOpenSci editor comments (https://github.com/ropensci/software-review/issues/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.

### BREAKING CHANGES

* 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)

### NEW FEATURES

* Clearer and more detailed user documentation in README and package website

### MINOR IMPROVEMENTS

* 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`


browseMetadata 2.0.2 (2024-12-12)
=========================

Expand All @@ -10,12 +37,12 @@ browseMetadata 2.0.2 (2024-12-12)

### MINOR IMPROVEMENTS

* 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
* 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



0 comments on commit 329bd92

Please sign in to comment.