feat: add progress arg to polarMap() etc.

NEWS.md

@@ -4,6 +4,8 @@
 
 * Pairwise statistics (e.g., `"robust_slope"`) are now supported by `polarMap()`. (#72)
 
+* The `polarMap()` family has gained the `progress` argument, allowing users to switch the progress bar on and off.
+
 ## Bug fixes
 
 * Vectors greater than length 1 passed to `popup` in the `polarMap()` argument will no longer error when `type = NULL`.

R/polar_annulusMap.R

@@ -61,6 +61,7 @@ annulusMap <- function(data,
                        d.fig = 3.5,
                        static = FALSE,
                        static.nrow = NULL,
+                       progress = TRUE,
                        ...,
                        control = NULL) {
   # check basemap providers are valid
@@ -116,7 +117,7 @@ annulusMap <- function(data,
   }
 
   # cut data
-  data <- openair::cutData(x = data, type = type, ...)
+  data <- openair::cutData(x = data, type = type %||% "default", ...)
 
   # deal with popups
   if (length(popup) > 1) {
@@ -195,7 +196,8 @@ annulusMap <- function(data,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {

R/polar_diffMap.R

@@ -80,6 +80,7 @@ diffMap <- function(before,
                     d.fig = 3.5,
                     static = FALSE,
                     static.nrow = NULL,
+                    progress = TRUE,
                     ...,
                     control = NULL) {
   # check basemap providers are valid
@@ -220,7 +221,8 @@ diffMap <- function(before,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {
@@ -323,7 +325,8 @@ create_polar_diffmarkers <-
            popup = NULL,
            label = NULL,
            d.fig,
-           dropcol = "conc") {
+           dropcol = "conc",
+           progress = TRUE) {
     # make temp directory
     dir <- tempdir()
 
@@ -400,7 +403,7 @@ create_polar_diffmarkers <-
         by = c(latitude, longitude, split_col)
       ) %>%
       dplyr::mutate(
-        plot = purrr::map2(before, after, fun, .progress = "Creating Polar Markers"),
+        plot = purrr::map2(before, after, fun, .progress = ifelse(progress, "Creating Polar Markers", FALSE)),
         url = paste0(dir, "/", .data[[latitude]], "_", .data[[longitude]], "_", .data[[split_col]], "_", id, ".png")
       )
 

R/polar_freqMap.R

@@ -84,6 +84,7 @@ freqMap <- function(data,
                     d.fig = 3.5,
                     static = FALSE,
                     static.nrow = NULL,
+                    progress = TRUE,
                     ...,
                     control = NULL) {
   # check basemap providers are valid
@@ -214,7 +215,8 @@ freqMap <- function(data,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {

R/polar_percentileMap.R

@@ -70,6 +70,7 @@ percentileMap <- function(data,
                           d.fig = 3.5,
                           static = FALSE,
                           static.nrow = NULL,
+                          progress = TRUE,
                           ...,
                           control = NULL) {
   # check basemap providers are valid
@@ -187,7 +188,8 @@ percentileMap <- function(data,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {

R/polar_polarMap.R

@@ -269,6 +269,14 @@
 #'   [ggplot2::facet_wrap()]. The default, `NULL`, results in a roughly square
 #'   grid of panels.
 #'
+#' @param progress *Show a progress bar?*
+#'
+#'  *default:* `TRUE` | *scope:* dynamic & static
+#'
+#'   By default, a progress bar is shown to visualise the function's progress
+#'   creating individual polar markers. This option allows this to be turned
+#'   off, if desired.
+#'
 #' @param control **Deprecated.** Please use `type`.
 #'
 #' @inheritDotParams openair::polarPlot -mydata -pollutant -x -limits -type
@@ -317,6 +325,7 @@ polarMap <- function(data,
                      d.fig = 3.5,
                      static = FALSE,
                      static.nrow = NULL,
+                     progress = TRUE,
                      ...,
                      control = NULL) {
   # list pairwise statistics
@@ -473,7 +482,8 @@ polarMap <- function(data,
       d.fig = d.fig,
       popup = popup,
       label = label,
-      dropcol = funpoll
+      dropcol = funpoll,
+      progress = progress
     )
 
   if (!static) {

R/polar_pollroseMap.R

@@ -73,6 +73,7 @@ pollroseMap <- function(data,
                         d.fig = 3.5,
                         static = FALSE,
                         static.nrow = NULL,
+                        progress = TRUE,
                         ...,
                         control = NULL) {
   # check basemap providers are valid
@@ -167,7 +168,8 @@ pollroseMap <- function(data,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {

R/polar_windroseMap.R

@@ -77,6 +77,7 @@ windroseMap <- function(data,
                         d.fig = 3.5,
                         static = FALSE,
                         static.nrow = NULL,
+                        progress = TRUE,
                         ...,
                         control = NULL) {
   # check basemap providers are valid
@@ -173,7 +174,8 @@ windroseMap <- function(data,
       split_col = split_col,
       d.fig = d.fig,
       popup = popup,
-      label = label
+      label = label,
+      progress = progress
     )
 
   if (static) {

R/utils-map.R

@@ -423,7 +423,8 @@ create_polar_markers <-
            popup = NULL,
            label = NULL,
            d.fig,
-           dropcol = "conc") {
+           dropcol = "conc",
+           progress = TRUE) {
     # make temp directory
     dir <- tempdir()
 
@@ -468,7 +469,7 @@ create_polar_markers <-
     plots_df <-
       nested_df %>%
       dplyr::mutate(
-        plot = purrr::map(data, fun, .progress = "Creating Polar Markers"),
+        plot = purrr::map(data, fun, .progress = ifelse(progress, "Creating Polar Markers", FALSE)),
         url = paste0(
           dir,
           "/",