feat: added 'algorithm' argument to location_createID()

DESCRIPTION

@@ -1,6 +1,6 @@
 Type: Package
 Package: MazamaLocationUtils
-Version: 0.3.10
+Version: 0.3.11
 Title: Manage Spatial Metadata for Known Locations
 Authors@R: c(
     person("Jonathan", "Callahan", email="[email protected]", role=c("aut","cre")),
@@ -16,17 +16,17 @@ License: GPL-3
 URL: https://github.com/MazamaScience/MazamaLocationUtils
 BugReports: https://github.com/MazamaScience/MazamaLocationUtils/issues
 Depends:
-    R (>= 3.5)
+    R (>= 4.0)
 Imports:
     dplyr,
-    geodist (>= 0.0.7),
+    geodist (>= 0.0.8),
     httr,
     jsonlite,
     leaflet,
     lubridate,
     magrittr,
     methods,
-    MazamaCoreUtils (>= 0.4.10),
+    MazamaCoreUtils (>= 0.4.16),
     MazamaSpatialUtils (>= 0.7),
     readr,
     rlang,
@@ -41,5 +41,5 @@ Suggests:
 Encoding: UTF-8
 VignetteBuilder: knitr
 LazyData: true
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)

NEWS.md

@@ -1,3 +1,9 @@
+# MazamaLocationUtils 0.3.11
+
+* Added `algorithm argument` to location_createID() to select between "digest"
+and "geohash".
+* Addressed CRAN package documentation issue.
+
 # MazamaLocationUtils 0.3.10
 
 * Added `na.rm = TRUE` to all calls to `any(...)` in various `table_~()` functions.

R/MazamaLocationUtils.R

@@ -1,6 +1,7 @@
 #'
 #' @docType package
 #' @name MazamaLocationUtils
+#' @aliases MazamaLocationUtils-package
 #' @title Manage Spatial Metadata for Known Locations
 #' @description A suite of utility functions for discovering and managing 
 #' metadata associated with sets of spatially unique "known locations".

R/location_createID.R

@@ -7,6 +7,7 @@
 #'
 #' @param longitude Vector of longitudes in decimal degrees E.
 #' @param latitude Vector of latitudes in decimal degrees N.
+#' @param algorithm Algorithm to use -- either \code{"digest"} or \code{"geohash"}.
 #' @return Vector of character locationIDs.
 #' @examples
 #' library(MazamaLocationUtils)
@@ -16,17 +17,22 @@
 #' lat <- 47.423333
 #' locationID <- location_createID(lon, lat)
 #' print(locationID)
+#' 
+#' geohashID <- location_createID(lon, lat, algorithm = "geohash")
+#' print(geohashID)
+#' 
 #' @references \url{https://en.wikipedia.org/wiki/Decimal_degrees}
 #' @references \url{https://www.johndcook.com/blog/2017/01/10/probability-of-secure-hash-collisions/}
 #' @rdname location_createID
 #' @export 
 #' 
 location_createID <- function(
   longitude = NULL,
-  latitude = NULL
+  latitude = NULL,
+  algorithm = c("digest", "geohash")
 ) {
-  
-  returnVal <- MazamaCoreUtils::createLocationID(longitude, latitude)
+
+  returnVal <- MazamaCoreUtils::createLocationID(longitude, latitude, algorithm)
   return(returnVal)
 
 }