Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initialise package #2

Merged
merged 25 commits into from
Sep 5, 2024
Merged

Initialise package #2

merged 25 commits into from
Sep 5, 2024

Conversation

rmbielby
Copy link
Contributor

@rmbielby rmbielby commented Aug 29, 2024

Brief overview of changes

This PR sets the eesyapi repo up as a package with the base documentation (largely following dfeR and dfeshiny) and a first function: api_url(), which is used to render the url for a given API endpoint.

Why are these changes being made?

API users working in R need a set of helper functions to smooth access to the EES API and this lays the groundwork for us to create those functions.

Detailed description of changes

Setting up the package and adding a first function:

  • Created a basic readme for the repo
  • Copied across standard contributor guidelines, code of conduct etc from dfeshiny
  • Initiated pkgdown to render documentation to github.io
  • api_url() renders a url for an endpoint based on a set of parameters, including endpoint and dataset_id
  • created a basic set of tests for api_url()
  • set up workflows following what we have on dfeshiny

@rmbielby rmbielby self-assigned this Aug 29, 2024
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

R/eesapi_url.R Fixed Show resolved Hide resolved
R/eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
R/eesapi_url.R Fixed Show resolved Hide resolved
tests/testthat/test-eesapi_url.R Fixed Show resolved Hide resolved
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
tests/testthat/test-eesapi_url.R Fixed Show fixed Hide fixed
@rmbielby rmbielby requested a review from cjrace September 2, 2024 13:41
@rmbielby rmbielby added documentation Improvements or additions to documentation new feature New feature or request labels Sep 2, 2024
@rmbielby rmbielby linked an issue Sep 2, 2024 that may be closed by this pull request
@rmbielby rmbielby linked an issue Sep 2, 2024 that may be closed by this pull request
Copy link
Contributor

@cjrace cjrace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments, all very minor / quick ones. Couple of lintr things flagged too.

Also noticed this note - assuming it's because httr is in there ready for when we do use it and it's just giving a note because we're not using it yet, so you can ignore it.

image

.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/workflows/lintr.yml Outdated Show resolved Hide resolved
LICENSE Outdated Show resolved Hide resolved
R/eesapi_url.R Fixed Show resolved Hide resolved
R/eesapi_url.R Outdated Show resolved Hide resolved
R/eesapi_url.R Outdated Show resolved Hide resolved
R/eesapi_url.R Fixed Show resolved Hide resolved
R/eesapi_url.R Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rmbielby rmbielby merged commit 150a737 into main Sep 5, 2024
9 checks passed
@rmbielby rmbielby deleted the initialise-package branch September 18, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation new feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Function to render base url Initialise pkgdown
2 participants