Add function for downloading all the retriever datasets

R/get_retriever_data.R

@@ -1,5 +1,8 @@
-#' Get cleaned BBS data
-#' @description Gets prepped BBS data (as a list of abundance, covariates, and metadata) for a specified route and region. First run `prepare_bbs_data` to create these files from the raw BBS data tables
+#' @title Get cleaned BBS data
+#' @description Gets prepped BBS data (as a list of abundance, covariates, and 
+#'   metadata) for a specified route and region. First run `prepare_bbs_data` 
+#'   to create these files from the raw BBS data tables. If the files are not 
+#'   found, then `NULL` is returned.
 #' @param route Route number
 #' @param region Region number
 #' @param path Data storage path

R/utils-retriever-data.R

@@ -30,7 +30,7 @@ use_default_data_path <- function(path = NULL)
     portalr::use_default_data_path(path, ENV_VAR = "MATSS_DATA_PATH")
 }
 
-#' @title Download a dataset from data retriever
+#' @title Download data from the data retriever
 #' @aliases import_retriever_data
 #'  
 #' @description \code{install_retriever_data} downloads retriever datasets and 
@@ -59,7 +59,7 @@ install_retriever_data <- function(dataset, path = get_default_data_path(),
     folder_path <- file.path(path, dataset)
     if (dir.exists(folder_path) && !force_install)
     {
-        message("A folder already exists for \"", dataset, "\".\n", 
+        message("A folder already exists for \"", dataset, "\"... skipping.\n", 
                 "Use `force_install = TRUE` to overwrite it with a fresh install.")
     } else {
         # make the folder
@@ -75,7 +75,6 @@ install_retriever_data <- function(dataset, path = get_default_data_path(),
     }
 }
 
-#' @title Import a dataset downloaded from data retriever
 #' @rdname install_retriever_data
 #'
 #' @description \code{import_retriever_data} loads a previously downloaded 
@@ -113,4 +112,32 @@ import_retriever_data <- function(dataset, path = get_default_data_path())
                                          stringsAsFactors = FALSE)
     }
     return(tempdata)
-}
+}
+
+#' @rdname install_retriever_data
+#' 
+#' @description \code{download_datasets} is a wrapper around 
+#'   \code{\link{install_retriever_data}} to download multiple datasets, with 
+#'   the default to download all of the datasets that are supported.
+#'   
+#' @inheritParams install_retriever_data
+#' 
+#' @return NULL
+#' 
+#' @examples
+#' \dontrun{
+#'   download_datasets()
+#' }
+
+download_datasets <- function(dataset = c("breed-bird-survey", 
+                                          "veg-plots-sdl", 
+                                          "mapped-plant-quads-mt", 
+                                          "biotimesql"), 
+                              path = get_default_data_path(), 
+                              force_install = FALSE)
+{
+    purrr::walk(dataset, 
+                install_retriever_data, 
+                path = path, 
+                force_install = force_install)
+}

_pkgdown.yml

@@ -21,6 +21,7 @@ reference:
   - title: "Rdataretriever"
     desc: "Functions that use Rdataretriever to download and import data"
     contents:
+      - download_retriever_datasets
       - import_retriever_data
       - install_retriever_data
   - title: "Get Data"