specify active R session

R/get_agfd.R

@@ -46,7 +46,7 @@
 #' using [tools::R_user_dir] to identify the proper directory for storing user
 #' data in a cache for this package. Defaults to `TRUE`, caching the files
 #' locally. If `FALSE`, this function uses `tempdir()` and the files are deleted
-#' upon closing of the \R session.
+#' upon closing of the active \R session.
 #'
 #' @section Model scenarios:
 #'

R/get_soil_thickness.R

@@ -4,7 +4,7 @@
 #' using `tools::R_user_dir()` to identify the proper directory for storing
 #' user data in a cache for this package. Defaults to `TRUE`, caching the files
 #' locally. If `FALSE`, this function uses `tempdir()` and the files are deleted
-#' upon closing of the \R session.
+#' upon closing of the active \R session.
 #'
 #' A custom `print` method is provided that will print the metadata associated
 #'  with these data. Examples are provided for interacting with the metadata
@@ -77,7 +77,7 @@ get_soil_thickness <- function(cache = TRUE) {
 #' using `tools::R_user_dir()` to identify the proper directory for storing
 #' user data in a cache for this package. Defaults to `TRUE`, caching the files
 #' locally. If `FALSE`, this function uses `tempdir()` and the files are deleted
-#' upon closing of the \R session.
+#' upon closing of the active \R session.
 #'
 #' @return Nothing, called for its side-effects of downloading and unzipping
 #'  files.

R/read_aagis_regions.R

@@ -5,12 +5,12 @@
 #'  import, the geometries  are automatically corrected to fix invalid
 #'  geometries that are present in the original shapefile.
 #'
-#' @param cache `Boolean` Cache the \acronym{AAGIS} regions' geospatial file
-#'  after downloading using `tools::R_user_dir("read.abares", "cache")` to
-#'  identify the proper directory for storing user data in a cache for this
-#'  package. Defaults to `TRUE`, caching the files locally as a Geopackage. If
-#'  `FALSE`, this function uses `tempdir()` and the files are deleted upon
-#'  closing of the \R session.
+#' @param cache Cache the \acronym{AAGIS} regions' geospatial file after
+#' downloading using `tools::R_user_dir("read.abares", "cache")` to identify the
+#' proper directory for storing user data in a cache for this package. Defaults
+#' to `TRUE`, caching the files locally as a Geopackage. If `FALSE`, this
+#' function uses `tempdir()` and the files are deleted upon closing of the
+#' active \R session.
 #'
 #' @examplesIf interactive()
 #' aagis <- read_aagis_regions()

R/read_abares_trade.R

@@ -10,7 +10,7 @@
 #'  using `tools::R_user_dir()` to identify the proper directory for storing
 #'  user data in a cache for this package. Defaults to `TRUE`, caching the files
 #'  locally as a native \R object. If `FALSE`, this function uses `tempdir()`
-#'  and the files are deleted upon closing of the \R session.
+#'  and the files are deleted upon closing of the active \R session.
 #'
 #' @examplesIf interactive()
 #' trade <- read_abares_trade()
@@ -45,7 +45,7 @@ read_abares_trade <- function(cache = TRUE) {
 #'  download using `tools::R_user_dir()` to identify the proper directory for
 #'  storing user data in a cache for this package. Defaults to `TRUE`, caching
 #'  the files locally as a native \R object. If `FALSE`, this function uses
-#'  `tempdir()` and the files are deleted upon closing of the \R session.
+#'  `tempdir()` and the files are deleted upon closing of the active \R session.
 #'
 #' @return A \CRANpkg{data.table} object of the \acronym{ABARES} trade data.
 #' @noRd

R/read_abares_trade_regions.R

@@ -10,7 +10,7 @@
 #'  download using `tools::R_user_dir()` to identify the proper directory for
 #'  storing user data in a cache for this package. Defaults to `TRUE`, caching
 #'  the files locally as a native \R object. If `FALSE`, this function uses
-#'  `tempdir()` and the files are deleted upon closing of the \R session.
+#'  `tempdir()` and the files are deleted upon closing of the active \R session.
 #'
 #' @examplesIf interactive()
 #' trade_regions <- read_abares_trade_regions()
@@ -79,7 +79,7 @@ read_abares_trade_regions <- function(cache = TRUE) {
 #'  download using `tools::R_user_dir()` to identify the proper directory for
 #'  storing user data in a cache for this package. Defaults to `TRUE`, caching
 #'  the files locally as a native \R object. If `FALSE`, this function uses
-#'  `tempdir()` and the files are deleted upon closing of the \R session.
+#'  `tempdir()` and the files are deleted upon closing of the active \R session.
 #'
 #' @return A \CRANpkg{data.table} object of the \acronym{ABARES} trade data.
 #' @noRd