Merge pull request nationalparkservice#114 from RobLBaker/master

update get_park_polygon API;
RobLBaker · Jun 28, 2024 · 69b520b · 69b520b
2 parents e6a882f + 4baccf7
commit 69b520b
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 36 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # QCkit v0.1.8 (not yet released)
 
+2024-06-28
+* Updated `get_park_polygon()` to use the new API (had been using a legacy API). Added documentation to specify that the function is getting the convexhull for the park, which may not work particularly well for some parks.
 2024-06-27
 * bug fixes for `generate_ll_from_utm()`
 * add function `remove_empty_tables()` (and associated unit tests)

diff --git a/R/geography.R b/R/geography.R
@@ -103,7 +103,7 @@ return(in_park)
 #' Retrieve the polygon information for the park unit from NPS REST services
 #'
 #' @description `get_park_polygon()` retrieves a geoJSON string for a polygon of
-#'a park unit. This is not the official boundary.
+#'a park unit. This is not the official boundary. Note that the REST API call returns the default "convexHull". This is will work better or worse for some parks, depending on the park shape/geography/number of disjunct areas.
 #' #'
 #' @param unit_code is the four-character unit code as designated by NPS.
 #'
@@ -114,7 +114,7 @@ return(in_park)
 #' }
 get_park_polygon <- function(unit_code) {
   # get geography from NPS Rest Services
-  units_url <- paste0("https://irmaservices.nps.gov/v2/rest/unit/",
+  units_url <- paste0("https://irmaservices.nps.gov/Unit/v2/api/",
                       unit_code,
                       "/geography")
   xml <- httr::content(httr::GET(units_url))

diff --git a/R/replace_blanks.R b/R/replace_blanks.R
@@ -69,7 +69,7 @@ replace_blanks <- function(directory = here::here(), missing_val_code = NA) {
   #extract just the file name
   my_path <- basename(my_path)
 
-  #give each dataframe a name basd on the filename where it originated
+  #give each dataframe a name based on the filename where it originated
   names(my_data) <- gsub(".csv", "", my_path)
 
   #replace all <NA> with the designated missing value code.

diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,7 +5,5 @@ articles:
   DRR_Purpose_and_Scope: DRR_Purpose_and_Scope.html
   Starting-a-DRR: Starting-a-DRR.html
   Using-the-DRR-Template: Using-the-DRR-Template.html
-
-last_built: 2024-06-27T19:41Z
-
+last_built: 2024-06-28T15:11Z
 
diff --git a/docs/reference/convert_datetime_format.html b/docs/reference/convert_datetime_format.html
diff --git a/docs/reference/get_park_polygon.html b/docs/reference/get_park_polygon.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/replace_blanks.html b/docs/reference/replace_blanks.html
diff --git a/man/get_park_polygon.Rd b/man/get_park_polygon.Rd