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

Update (version 1.2.0) #15

Merged

Conversation

eroten
Copy link
Collaborator

@eroten eroten commented Dec 18, 2023

v1.2.0

New functions

  • Tags
    • create_tag() creates a new tag
    • list_available_tags() returns a tibble with all available tags for the user account.
    • tag_analysis() tags an analysis using the analysis name
    • remove_analysis_tag() remove a tag from an analysis
  • Parameter validation
    • new dataset: valid_parameters
    • validate_parameters() takes a parameter name and value, and checks it against various tests.
    • most functions now have parameter validation.
  • Analysis functions
    • get_analysis_shapefile() fetches available shapefiles from a given analysis, returned as an {sf} object
    • lookup_analysis_id() returns corresponding analysis_name or uuid, dependent on input.
    • check_analysis_review() returns the review status, if available

Other changes

  • Enhance testing procedures
  • Update API key secret
  • Increment dependencies
  • Updated README and documentation
  • fix inconsistent error and warning handling
  • Added time in between various tests to avoid hitting the Streetlight API rate limit. This has increased the time it takes to run package tests

Fixes #14 #5 #9

Package development checklist

  • usethis::use_latest_dependencies()
  • usethis::use_tidy_description()
  • devtools::test()
  • devtools::document(roclets = c('rd', 'collate', 'namespace'))
  • Update DESCRIPTION with new contributors, if neccessary.
  • Double check your documentation
  • styler:::style_active_pkg()
  • rcmdcheck::rcmdcheck()
    • fix errors
    • fix simple warnings and notes

Courtesy checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have tagged this PR appropriately

@eroten eroten self-assigned this Dec 18, 2023
@eroten eroten linked an issue Dec 18, 2023 that may be closed by this pull request
@eroten eroten force-pushed the 14-update-streetlightr-to-align-with-most-recent-api-changes branch from a9f0537 to ccb5793 Compare December 19, 2023 16:40
@eroten eroten linked an issue Dec 19, 2023 that may be closed by this pull request
@eroten eroten marked this pull request as ready for review December 19, 2023 20:36
@eroten eroten merged commit 9eb2215 into main Dec 19, 2023
2 checks passed
@eroten eroten deleted the 14-update-streetlightr-to-align-with-most-recent-api-changes branch December 19, 2023 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant