Better geography function documentation#32
Merged
nataliec-sss merged 8 commits intomainfrom Oct 9, 2025
Merged
Conversation
nataliec-sss
approved these changes
Oct 9, 2025
Contributor
nataliec-sss
left a comment
There was a problem hiding this comment.
Ken, i think the changes to the documentation and the ability to use test functionality without the config file is great. I've run the tests and everything passed so content to approve this pull request.
Could we please mark this as a release? I'm concerned we are aren't updating package version numbers with each update so i think that this would be a good way to introduce this.
This file contains hidden or 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
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.
Purpose of this pull request
To improve the function documentation for the following functions:
get_datazone_lookup();get_simd_lookup();get_sspl_lookup();add_geography().Main changes
seealsotag and an example. Note all of those examples are wrapped in\dontrun{}to avoid encountering issues with github actions for this package.datafrom therlangpackage and tidy selection to deal with data masking previously triggered R CMD Check notes on "no visible binding".My ask for reviewers of this pull request
Feedback on those changes would be appreciated, e.g. is the function documentation for any function clearer? Are examples easy to read and understand despite the example for
get_sspl_lookup()would not work since people would have to download the Scottish Statistics Postcode Lookup to their local device?Please note that this pull request will still fail some github actions, and I hope to try to resolve this immediately if this pull request is approved.
Ken