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

Initial minimal implementation of the VegBank R client #2

Open
6 tasks done
regetz opened this issue Feb 7, 2025 · 0 comments
Open
6 tasks done

Initial minimal implementation of the VegBank R client #2

regetz opened this issue Feb 7, 2025 · 0 comments
Assignees
Labels
D-2.3 Publish an open-source R package for VegBank

Comments

@regetz
Copy link
Collaborator

regetz commented Feb 7, 2025

Outcome

Minimal R package that includes working code to retrieve a plot using the VegBank REST API, and passes all basic checks.

Details

Aligned with the initial API implementation deliverable under issue NCEAS/vegbank2#41, this initial MVP should include functionality for querying via the VegBank REST API for a single plot observation using the observation accession code, and returning the response as a data.frame.

Out of scope

  • Validation of the input accession code
  • Validation of the returned response
  • Error handling

Acceptance criteria

  • R package passes standard checks (R CMD check / devtools::check())
  • R package contains a meaningful DESCRIPTION file with valid license
  • R package can be loaded.
  • Package provides a way to set & get the API base URL, especially to enable testing of the API deployed to the local testing environment.
  • Package provides a way to hit the VegBank API and return a single plot observation record associated with a requested (and valid) accession code.
  • Created functions have useful (albeit minimal) and valid documentation
@regetz regetz added the D-2.3 Publish an open-source R package for VegBank label Feb 7, 2025
@regetz regetz self-assigned this Feb 7, 2025
@regetz regetz moved this to In Progress in VegBank Project Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-2.3 Publish an open-source R package for VegBank
Projects
Status: In Progress
Development

No branches or pull requests

1 participant