update examples to show error message if invalid/missing API key

rmgpanw · May 26, 2024 · 64dfbe1 · 64dfbe1
1 parent aeaf41b
commit 64dfbe1
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/R/download_item.R b/R/download_item.R
@@ -36,6 +36,9 @@
 #'
 #'  unzip(y, list = TRUE)
 #' }
+#'
+#' # An informative error is raised if your API key is invalid or missing
+#' try(download_item(394, TRUD_API_KEY = "INVALID_API_KEY"))
 download_item <- function(item,
                           directory = ".",
                           download_file = "archive",

diff --git a/R/get_item_metadata.R b/R/get_item_metadata.R
@@ -20,6 +20,9 @@
 #' get_item_metadata(394, latest_only = FALSE) |>
 #'    purrr::map_at("releases", \(release) purrr::map(release, names))
 #' }
+#'
+#' # An informative error is raised if your API key is invalid or missing
+#' try(download_item(394, TRUD_API_KEY = "INVALID_API_KEY"))
 get_item_metadata <- function(item,
                               TRUD_API_KEY = NULL,
                               latest_only = FALSE) {

diff --git a/man/download_item.Rd b/man/download_item.Rd
diff --git a/man/get_item_metadata.Rd b/man/get_item_metadata.Rd
diff --git a/man/trud-package.Rd b/man/trud-package.Rd