GET publication info #21
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
…se into data frames
…r::select and rename
…set and publication ids going forward
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
cjrace
requested changes
Sep 16, 2024
…eshing test data and documenting code
cjrace
approved these changes
Sep 17, 2024
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.
Brief overview of changes
Dithered a little over the scope of this one, but settled on two things:
Why are these changes being made?
The aim is to provide a basis for analysts to easily query the API publication list and range of datasets from within R.
Detailed description of changes
The core of this is those two processes, which are handled by the new functions:
get_publication_catalogue()get_publication_datasets()Alongside those I've built up
eesapi_url()to handle those endpoints and to handle things like the Page and pageSize flags used in querying the API. That's also led on to building some more robust validation around things we're using to create API URLs, for which I've started a separate script: validation_rules.R.Additional information for reviewers
I've been keeping everything exported for now as:
a) it's hard to say what end users will and won't find a use for themselves and
b) things break when I don't export things (aka I need to do some reading into how to use non-exported functions, which feels like a me-in-2-weeks-time thing to do).
Issue ticket number/s and link
#15