document verbosity control

Author: AAoritz

DESCRIPTION

@@ -41,6 +41,7 @@ Suggests:
     readr,
     rmarkdown,
     sf,
+    stringr,
     terra,
     testthat,
     tidyr,

R/nuts_aggregate.R

@@ -13,6 +13,8 @@
 #'
 #' @return A tibble containing NUTS codes, aggregated variable values, and possibly grouping variables.
 #'
+#' @details Console messages can be controlled with `rlang::local_options(nuts.verbose = "quiet")` to silence messages and
+#' `nuts.verbose = "verbose"` to switch messages back on.
 #'
 #' @examples
 #' library(dplyr)
@@ -26,7 +28,7 @@
 #'# Aggregate from NUTS 3 to 2 by indicator x year
 #' manure %>%
 #'   filter(nchar(geo) == 5) %>%
-#'   classify_nuts(nuts_code = "geo",
+#'   nuts_classify(nuts_code = "geo",
 #'                 group_vars = c('indic_ag','time')) %>%
 #'   # Group vars are automatically passed on
 #'   nuts_aggregate(to_level = 2,

R/nuts_classify.R

@@ -16,6 +16,9 @@
 #'
 #' The output can be passed to [nuts_convert_version()] to convert data across NUTS versions and [nuts_aggregate()] to aggregate across NUTS levels.
 #'
+#' @details Console messages can be controlled with `rlang::local_options(nuts.verbose = "quiet")` to silence messages and
+#' `nuts.verbose = "verbose"` to switch messages back on.
+#'
 #'
 #' @examples
 #' library(dplyr)

R/nuts_convert_version.R

@@ -13,6 +13,8 @@
 #'
 #' @return A tibble containing NUTS codes, converted variable values, and possibly grouping variables.
 #'
+#' @details Console messages can be controlled with `rlang::local_options(nuts.verbose = "quiet")` to silence messages and
+#' `nuts.verbose = "verbose"` to switch messages back on.
 #'
 #' @examples
 #' library(dplyr)
@@ -31,7 +33,7 @@
 #'   filter(time == 2003) %>%
 #'   select(-indic_ag, -time) %>%
 #'   # Data now only varies at the NUTS code level
-#'   classify_nuts(nuts_code = "geo") %>%
+#'   nuts_classify(nuts_code = "geo") %>%
 #'   nuts_convert_version(to_version = '2021',
 #'                        weight = 'pop18',
 #'                        variables = c('values' = 'absolute'))
@@ -43,7 +45,7 @@
 #'   filter(indic_ag == 'I07A_EQ_Y') %>%
 #'   select(-indic_ag) %>%
 #'   # Data now varies at the year x NUTS code level
-#'   classify_nuts(nuts_code = 'geo', group_vars = c('time')) %>%
+#'   nuts_classify(nuts_code = 'geo', group_vars = c('time')) %>%
 #'   nuts_convert_version(to_version = '2021',
 #'                        weight = 'pop18',
 #'                        variables = c('values' = 'absolute'))

README.md

@@ -23,6 +23,11 @@ pak::pak("AAoritz/nuts/")
 
 Check out the [website](https://aaoritz.github.io/nuts/articles/nuts-vignette.html) for example usage and further details.
 
+### Verbosity Control
+
+Console messages can be controlled with `rlang::local_options(nuts.verbose = "quiet")` to silence messages and setting `nuts.verbose = "verbose"` to switch messages back on.
+
+
 ### Citation
 
 Please support the development of open science and data by citing the JRC and us in your work:

_pkgdown.yml

@@ -7,7 +7,7 @@ reference:
 - title: Functions
   desc:  Functions that classify and convert regional data
 - contents:
-    starts_with("convert_|classify_")
+    starts_with("nuts_classify|nuts_aggregate|nuts_convert")
 - title: Data
   desc:  Data sets required for conversion and examples
 - contents:

docs/index.html

@@ -3,7 +3,7 @@ pkgdown: 2.0.7
 pkgdown_sha: ~
 articles:
   nuts: nuts.html
-last_built: 2024-02-07T21:11Z
+last_built: 2024-02-20T21:42Z
 urls:
   reference: https://aaoritz.github.io/nuts/reference
   article: https://aaoritz.github.io/nuts/articles