Merge pull request nationalparkservice#121 from RobLBaker/master

better hide internal functions from users
RobLBaker · Sep 20, 2024 · f63462f · f63462f
2 parents 39ffe96 + b0ac08c
commit f63462f
Show file tree

Hide file tree

Showing 51 changed files with 518 additions and 986 deletions.
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -62,7 +62,7 @@ Imports:
     cli,
     purrr,
     lifecycle
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Suggests: 
     knitr,
     rmarkdown,

diff --git a/NAMESPACE b/NAMESPACE
@@ -18,7 +18,6 @@ export(get_dp_flags)
 export(get_elevation)
 export(get_park_polygon)
 export(get_taxon_rank)
-export(get_user_email)
 export(get_utm_zone)
 export(long2UTM)
 export(order_cols)

diff --git a/R/geography.R b/R/geography.R
@@ -60,6 +60,8 @@ return(in_park)
 #' @param park_units String. Or list of strings.
 #'
 #' @return sf dataframe
+#' @keywords internal
+#' @noRd
 #' @examples
 #' \dontrun{
 #' .get_unit_boundary("ROMO")

diff --git a/R/utils.R b/R/utils.R
@@ -49,7 +49,8 @@ globalVariables(c("any_of",
 #' This function probaby won't work for anyone outside of NPS and likely won't work for anyone who is not using a Windows machine. So build those prerequisites (NPS = FALSE) in when calling it from within other function.
 #'
 #' @return String. The user's email address.
-#' @export
+#' @keywords internal
+#' @noRd
 #'
 #' @examples
 #' \dontrun{

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/DRR_Purpose_and_Scope.html b/docs/articles/DRR_Purpose_and_Scope.html