improved tm_symbols messages

r-tmap · Apr 18, 2024 · 14b907c · 14b907c
1 parent 04ccd90
commit 14b907c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 23 deletions.
diff --git a/R/misc_v3_comp.R b/R/misc_v3_comp.R
@@ -4,14 +4,14 @@ v3_only = function(fun) {
 
 v3_start_message = function() {
  if (!.TMAP$v3) {
- message("tmap v3 code detected:")
- .TMAPv3 = TRUE
+ message("tmap v3 code detected. Specific changes listed below.")
+ .TMAP$v3 = TRUE
  }
  invisible(NULL)
 }
 
 v3_reset_flag = function() {
- .TMAPv3 = FALSE
+ .TMAP$v3 = FALSE
  invisible(NULL)
 }
 
@@ -28,7 +28,7 @@ v3_instead = function(args_called, old, new, fun, extra_called = character()) {
  if (length(extra_called)) {
  called = unique(c(called, extra_called))
  }
- message(paste0(fun, ": (v3->v4), use '", new, "' instead of '", old, "'"))
+ message(paste0(fun, " (v3->v4): use '", new, "' instead of '", old, "'"))
  }
  list(args = args, called = called)
 }
@@ -42,7 +42,7 @@ v3_instead_value = function(args_called, old, new, fun, value_old, value_new) {
  args[[old]] = NULL
  args[[new]] = value_new
  if (is.null(value_old)) value_old = "NULL" 
- message(paste0(fun, ": (v3->v4), use '", new, " = ", value_new, "' instead of '", old, " = ", value_old, "'"))
+ message(paste0(fun, " (v3->v4): use '", new, " = ", value_new, "' instead of '", old, " = ", value_old, "'"))
  list(args = args, called = called)
  } else {
  v3_instead(args_called, old, new, fun)

diff --git a/R/tm_layers_symbols.R b/R/tm_layers_symbols.R
@@ -260,26 +260,10 @@ tm_symbols = function(size = tm_const(),
 }
 
 v3_symbols = function(args, args_called) {
- v3 = c("alpha", "border.col", "border.lwd", "border.alpha", "scale", 
- "perceptual", "clustering", "size.max", "size.lim", "sizes.legend", 
- "sizes.legend.labels", "n", "style", "style.args", "as.count", 
- "breaks", "interval.closure", "palette", "labels", "drop.levels", 
- "midpoint", "stretch.palette", "contrast", "colorNA", "textNA", 
- "showNA", "colorNULL", "shapes", "shapes.legend", "shapes.legend.fill", 
- "shapes.labels", "shapes.drop.levels", "shapeNA", "shape.textNA", 
- "shape.showNA", "shapes.n", "shapes.style", "shapes.style.args", 
- "shapes.as.count", "shapes.breaks", "shapes.interval.closure", 
- "legend.max.symbol.size", "just", "jitter", "xmod", "ymod", "icon.scale", 
- "grob.dim", "title.size", "title.col", "title.shape", "legend.size.show", 
- "legend.col.show", "legend.shape.show", "legend.format", "legend.size.is.portrait", 
- "legend.col.is.portrait", "legend.shape.is.portrait", "legend.size.reverse", 
- "legend.col.reverse", "legend.shape.reverse", "legend.hist", 
- "legend.hist.title", "legend.size.z", "legend.col.z", "legend.shape.z", 
- "legend.hist.z", "id", "interactive", "popup.vars", "popup.format", 
- "auto.palette.mapping", "max.categories")
+ v3 = v3_only("tm_symbols")
 
  if (any(v3 %in% names(args))) {
- message("tm_symbols: Deprecated tmap v3 code detected. Code translated to v4")
+ v3_start_message()
  if (!("style" %in% names(args))) {
  if (!"breaks" %in% names(args)) {
  style = "pretty"
@@ -330,6 +314,11 @@ v3_symbols = function(args, args_called) {
  stop("unknown style")
  }
 
+ if ("style" %in% names(args)) {
+ message("tm_symbols (v3->v4): instead of 'style = \"", style, "\"', pleaase use 'fill.scale = tm_scale_", fill.scale.args$fun_pref, "()'")
+ }
+
+
  fill.scale = do.call("tm_scale", args = fill.scale.args) 
 
  if ("col" %in% names(args_called)) {