fix @returns tag in ROxygen

R/clear_cache.R

@@ -8,7 +8,7 @@
 #' clear_cache()
 #' }
 #' @family cache
-#' @return Nothing, called for its side-effects, clearing the cached files.
+#' @returns Nothing, called for its side-effects, clearing the cached files.
 #' @export
 
 clear_cache <- function() {

R/get_agfd.R

@@ -172,7 +172,7 @@
 #' @examplesIf interactive()
 #' get_agfd()
 #'
-#' @return A `read.abares.agfd.nc.files` object, a `list` of NetCDF files
+#' @returns A `read.abares.agfd.nc.files` object, a `list` of NetCDF files
 #'  containing the Australian Gridded Farm Data.
 #' @family AGFD
 #' @autoglobal

R/get_soil_thickness.R

@@ -23,7 +23,7 @@
 #' y <- x$metadata
 #' pander(y)
 #'
-#' @return A `read.abares.soil.thickness` object, which is a named `list` with
+#' @returns A `read.abares.soil.thickness` object, which is a named `list` with
 #'  the file path of the resulting \acronym{ESRI} Grid file and text file of
 #'  metadata.
 #'
@@ -50,7 +50,7 @@ get_soil_thickness <- function(cache = TRUE) {
 #'
 #' @param dir File where files have been downloaded.
 #'
-#' @return A `read.abares.soil.thickness` object, which is a named `list` with
+#' @returns A `read.abares.soil.thickness` object, which is a named `list` with
 #'  the file path of the resulting \acronym{ESRI} Grid file and text file of
 #'  metadata.
 #' @dev
@@ -78,7 +78,7 @@ get_soil_thickness <- function(cache = TRUE) {
 #' locally. If `FALSE`, this function uses `tempdir()` and the files are deleted
 #' upon closing of the active \R session.
 #'
-#' @return Nothing, called for its side-effects of downloading and unzipping
+#' @returns Nothing, called for its side-effects of downloading and unzipping
 #'  files.
 #'
 #' @dev
@@ -176,7 +176,7 @@ print.read.abares.soil.thickness.files <- function(x, ...) {
 #'
 #' @param x A `read.abares.soil.thickness.files` object.
 #'
-#' @return Nothing, called for its side effects, it prints the complete
+#' @returns Nothing, called for its side effects, it prints the complete
 #'   metadata file to the \R console.
 #' @examplesIf interactive()
 #' get_soil_thickness(cache = TRUE) |>

R/inspect_cache.R

@@ -26,7 +26,7 @@
 #' basename(inspect_cache(recursive_true))
 #' }
 #' @family cache
-#' @return A `list` of directories or files in the cache
+#' @returns A `list` of directories or files in the cache
 #' @export
 
 inspect_cache <- function(recursive = FALSE) {

R/internal_functions.R

@@ -1,6 +1,6 @@
 #' Find the file path to the users' cache directory
 #'
-#' @return A `character` string value of a file path indicating the proper
+#' @returns A `character` string value of a file path indicating the proper
 #'  directory to use for cached files.
 #' @dev
 #' @autoglobal
@@ -13,7 +13,7 @@
 #' @param x An object for validating.
 #' @param class An S3 class to validate against.
 #'
-#' @return Nothing, called for its side-effects of class validation.
+#' @returns Nothing, called for its side-effects of class validation.
 #' @autoglobal
 #' @dev
 .check_class <- function(x, class) {
@@ -44,7 +44,7 @@
 #'   .f = f
 #' )
 #'
-#' @return Called for its side-effects, writes an object to the `tempdir()` for
+#' @returns Called for its side-effects, writes an object to the `tempdir()` for
 #'   reading into the active \R session later.
 #' @dev
 

R/read_aagis_regions.R

@@ -17,7 +17,7 @@
 #'
 #' plot(aagis)
 #'
-#' @return An \CRANpkg{sf} object of the \acronym{AAGIS} regions.
+#' @returns An \CRANpkg{sf} object of the \acronym{AAGIS} regions.
 #'
 #' @family AGFD
 #'
@@ -42,7 +42,7 @@ read_aagis_regions <- function(cache = TRUE) {
 #' cache, but is in `tempdir()`, it is saved to the cache before being returned
 #' in the current session.
 #'
-#' @return An \CRANpkg{sf} object of AAGIS regions.
+#' @returns An \CRANpkg{sf} object of AAGIS regions.
 #' @dev
 #' @autoglobal
 
@@ -79,7 +79,7 @@ read_aagis_regions <- function(cache = TRUE) {
 #'  function uses `tempdir()` and the files are deleted upon closing of the \R
 #'  session.
 #'
-#' @return An \CRANpkg{sf} object of AAGIS regions.
+#' @returns An \CRANpkg{sf} object of AAGIS regions.
 #' @dev
 #' @autoglobal
 

R/read_abares_trade.R

@@ -25,7 +25,7 @@
 #'
 #' trade
 #'
-#' @return A \CRANpkg{data.table} object of the \acronym{ABARES} trade data.
+#' @returns A \CRANpkg{data.table} object of the \acronym{ABARES} trade data.
 #' @family Trade
 #' @references <https://www.agriculture.gov.au/abares/research-topics/trade/dashboard>
 #' @source <https://daff.ent.sirsidynix.net.au/client/en_AU/search/asset/1033841/0>
@@ -55,7 +55,7 @@ read_abares_trade <- function(cache = TRUE) {
 #'  the files locally as a gzip file. If `FALSE`, this function uses
 #'  `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.
+#' @returns A \CRANpkg{data.table} object of the \acronym{ABARES} trade data.
 #' @noRd
 #' @autoglobal
 #' @keywords Internal

R/read_abares_trade_regions.R

@@ -11,7 +11,7 @@
 #'
 #' trade_regions
 #'
-#' @return A \CRANpkg{data.table} object of the \acronym{ABARES} trade data
+#' @returns A \CRANpkg{data.table} object of the \acronym{ABARES} trade data
 #'  regions.
 #' @family Trade
 #' @references <https://daff.ent.sirsidynix.net.au/client/en_AU/search/asset/1033841/0>

R/read_agfd_dt.R

@@ -9,7 +9,7 @@
 #' @inherit get_agfd references
 #' @param files A list of \acronym{AGFD} NetCDF files to import.
 #'
-#' @return a [data.table::data.table] object of the 'Australian Gridded Farm
+#' @returns a [data.table::data.table] object of the 'Australian Gridded Farm
 #'  Data'.
 #'
 #' @examplesIf interactive()

R/read_agfd_stars.R

@@ -10,7 +10,7 @@
 #' @inheritSection get_agfd Data layers
 #' @inherit get_agfd references
 #'
-#' @return a `list` object of \CRANpkg{stars} objects of the Australian Gridded
+#' @returns a `list` object of \CRANpkg{stars} objects of the Australian Gridded
 #'  Farm Data with the file names as the list's objects' names.
 #'
 #' @examplesIf interactive()

R/read_agfd_terra.R

@@ -10,7 +10,7 @@
 #' @inheritSection get_agfd Data layers
 #' @inherit get_agfd references
 #'
-#' @return a `list` object of [terra::rast] objects of the Australian Gridded
+#' @returns a `list` object of [terra::rast] objects of the Australian Gridded
 #'  Farm Data with the file names as the list's objects' names.
 #'
 #' @examplesIf interactive()

R/read_agfd_tidync.R

@@ -10,7 +10,7 @@
 #' @inheritSection get_agfd Data layers
 #' @inherit get_agfd references
 #'
-#' @return a `list` object of \CRANpkg{tidync} [tidync::tidync] objects of the
+#' @returns a `list` object of \CRANpkg{tidync} [tidync::tidync] objects of the
 #'  Australian Gridded Farm Data with the file names as the  list's objects'
 #'  names.
 #'

R/read_estimates_by_performance_category.R

@@ -1,6 +1,6 @@
 #' Read 'Estimates by Size' from ABARES
 #'
-#' @return A [data.table::data.table] object.
+#' @returns A [data.table::data.table] object.
 #' @export
 #' @references <https://www.agriculture.gov.au/abares/data/farm-data-portal#data-download>
 #' @source <https://www.agriculture.gov.au/sites/default/files/documents/fdp-BySize-ByPerformance.csv>

R/read_estimates_by_size.R

@@ -3,7 +3,7 @@
 #' @note
 #' Columns are renamed and reordered for consistency.
 #'
-#' @return A [data.table::data.table] object with the `Variable` field as the
+#' @returns A [data.table::data.table] object with the `Variable` field as the
 #'  `key`.
 #' @references <https://www.agriculture.gov.au/abares/data/farm-data-portal#data-download>
 #' @source <https://www.agriculture.gov.au/sites/default/files/documents/fdp-national-historical.csv>

R/read_historical_forecast_database.R

@@ -28,7 +28,7 @@
 #' @references <https://www.agriculture.gov.au/abares/research-topics/agricultural-outlook/historical-forecasts#:~:text=About%20the%20historical%20agricultural%20forecast,relevant%20to%20Australian%20agricultural%20markets>
 #' @source <https://daff.ent.sirsidynix.net.au/client/en_AU/search/asset/1031941/0>
 #'
-#' @return A [data.table::data.table] object.
+#' @returns A [data.table::data.table] object.
 #'
 #' @autoglobal
 #' @export

R/read_historical_national_estimates.R

@@ -4,7 +4,7 @@
 #' Columns are renamed for consistency with other \acronym{ABARES} products
 #'  serviced in this package using a snake_case format and ordered consistently.
 #'
-#' @return A [data.table::data.table] object with the `Variable` field as the
+#' @returns A [data.table::data.table] object with the `Variable` field as the
 #'  `key`.
 #' @autoglobal
 #' @family Estimates

R/read_historical_regional_estimates.R

@@ -4,7 +4,7 @@
 #' Columns are renamed for consistency with other \acronym{ABARES} products
 #'  serviced in this package using a snake_case format and ordered consistently.
 #'
-#' @return A [data.table::data.table] object with the `Variable` field as the
+#' @returns A [data.table::data.table] object with the `Variable` field as the
 #'  `key`.
 #' @autoglobal
 #' @family Estimates

R/read_historical_state_estimates.R

@@ -4,7 +4,7 @@
 #' Columns are renamed for consistency with other \acronym{ABARES} products
 #'  serviced in this package using a snake_case format and ordered consistently.
 #'
-#' @return A [data.table::data.table] object with the `Variable` field as the
+#' @returns A [data.table::data.table] object with the `Variable` field as the
 #'  `key`.
 #' @autoglobal
 #' @family Estimates

R/read_soil_thickness_stars.R

@@ -9,7 +9,7 @@
 #' @references <https://data.agriculture.gov.au/geonetwork/srv/eng/catalog.search#/metadata/faa9f157-8e17-4b23-b6a7-37eb7920ead6>
 #' @source <https://anrdl-integration-web-catalog-saxfirxkxt.s3-ap-southeast-2.amazonaws.com/warehouse/staiar9cl__059/staiar9cl__05911a01eg_geo___.zip>
 #'
-#' @return a [stars] object of the 'Soil Thickness for Australian Areas of
+#' @returns a [stars] object of the 'Soil Thickness for Australian Areas of
 #'  Intensive Agriculture of Layer 1'.
 #'
 #' @examplesIf interactive()

R/read_soil_thickness_terra.R

@@ -9,7 +9,7 @@
 #' @source <https://anrdl-integration-web-catalog-saxfirxkxt.s3-ap-southeast-2.amazonaws.com/warehouse/staiar9cl__059/staiar9cl__05911a01eg_geo___.zip>
 
 #'
-#' @return a [terra::rast] object of the 'Soil Thickness for Australian Areas of
+#' @returns a [terra::rast] object of the 'Soil Thickness for Australian Areas of
 #'  Intensive Agriculture of Layer 1'.
 #'
 #' @examplesIf interactive()

codemeta.json

@@ -333,7 +333,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "388.375KB",
+  "fileSize": "388.395KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",