diff --git a/R/get_agfd.R b/R/get_agfd.R index e5a3b10..aadf18f 100644 --- a/R/get_agfd.R +++ b/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: #' diff --git a/R/get_soil_thickness.R b/R/get_soil_thickness.R index 67ea66e..473c731 100644 --- a/R/get_soil_thickness.R +++ b/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. diff --git a/R/read_aagis_regions.R b/R/read_aagis_regions.R index 5831225..9083039 100644 --- a/R/read_aagis_regions.R +++ b/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() diff --git a/R/read_abares_trade.R b/R/read_abares_trade.R index 82226bc..068eba7 100644 --- a/R/read_abares_trade.R +++ b/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 diff --git a/R/read_abares_trade_regions.R b/R/read_abares_trade_regions.R index eaae616..0c586d7 100644 --- a/R/read_abares_trade_regions.R +++ b/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 diff --git a/man/get_agfd.Rd b/man/get_agfd.Rd index ef2c5fd..1e4f470 100644 --- a/man/get_agfd.Rd +++ b/man/get_agfd.Rd @@ -25,7 +25,7 @@ from the most recently completed financial year.} using \link[tools:userdir]{tools::R_user_dir} to identify the proper directory for storing user data in a cache for this package. Defaults to \code{TRUE}, caching the files locally. If \code{FALSE}, this function uses \code{tempdir()} and the files are deleted -upon closing of the \R session.} +upon closing of the active \R session.} } \value{ A \code{read.abares.agfd.nc.files} object, a \code{list} of NetCDF files diff --git a/man/get_soil_thickness.Rd b/man/get_soil_thickness.Rd index 6c3941a..5a68574 100644 --- a/man/get_soil_thickness.Rd +++ b/man/get_soil_thickness.Rd @@ -14,7 +14,7 @@ get_soil_thickness(cache = TRUE) using \code{tools::R_user_dir()} to identify the proper directory for storing user data in a cache for this package. Defaults to \code{TRUE}, caching the files locally. If \code{FALSE}, this function uses \code{tempdir()} and the files are deleted -upon closing of the \R session. +upon closing of the active \R session. A custom \code{print} method is provided that will print the metadata associated with these data. Examples are provided for interacting with the metadata diff --git a/man/read_aagis_regions.Rd b/man/read_aagis_regions.Rd index 7d0b105..8e3e1b3 100644 --- a/man/read_aagis_regions.Rd +++ b/man/read_aagis_regions.Rd @@ -10,12 +10,12 @@ read_aagis_regions(cache = TRUE) } \arguments{ -\item{cache}{\code{Boolean} Cache the \acronym{AAGIS} regions' geospatial file -after downloading using \code{tools::R_user_dir("read.abares", "cache")} to -identify the proper directory for storing user data in a cache for this -package. Defaults to \code{TRUE}, caching the files locally as a Geopackage. If -\code{FALSE}, this function uses \code{tempdir()} and the files are deleted upon -closing of the \R session.} +\item{cache}{Cache the \acronym{AAGIS} regions' geospatial file after +downloading using \code{tools::R_user_dir("read.abares", "cache")} to identify the +proper directory for storing user data in a cache for this package. Defaults +to \code{TRUE}, caching the files locally as a Geopackage. If \code{FALSE}, this +function uses \code{tempdir()} and the files are deleted upon closing of the +active \R session.} } \value{ An \CRANpkg{sf} object of the \acronym{AAGIS} regions. diff --git a/man/read_abares_trade.Rd b/man/read_abares_trade.Rd index 4e6ff2a..5eacc6c 100644 --- a/man/read_abares_trade.Rd +++ b/man/read_abares_trade.Rd @@ -14,7 +14,7 @@ read_abares_trade(cache = TRUE) using \code{tools::R_user_dir()} to identify the proper directory for storing user data in a cache for this package. Defaults to \code{TRUE}, caching the files locally as a native \R object. If \code{FALSE}, this function uses \code{tempdir()} -and the files are deleted upon closing of the \R session.} +and the files are deleted upon closing of the active \R session.} } \value{ A \CRANpkg{data.table} object of the \acronym{ABARES} trade data. diff --git a/man/read_abares_trade_regions.Rd b/man/read_abares_trade_regions.Rd index 63413ae..83f8f0f 100644 --- a/man/read_abares_trade_regions.Rd +++ b/man/read_abares_trade_regions.Rd @@ -14,7 +14,7 @@ read_abares_trade_regions(cache = TRUE) download using \code{tools::R_user_dir()} to identify the proper directory for storing user data in a cache for this package. Defaults to \code{TRUE}, caching the files locally as a native \R object. If \code{FALSE}, this function uses -\code{tempdir()} and the files are deleted upon closing of the \R session.} +\code{tempdir()} and the files are deleted upon closing of the active \R session.} } \value{ A \CRANpkg{data.table} object of the \acronym{ABARES} trade data