Rename size aesthetic for line-based geoms (#3672)

DESCRIPTION

@@ -221,6 +221,7 @@ Collate:
     'scale-hue.r'
     'scale-identity.r'
     'scale-linetype.r'
+    'scale-linewidth.R'
     'scale-manual.r'
     'scale-shape.r'
     'scale-size.r'

NAMESPACE

@@ -557,6 +557,13 @@ export(scale_linetype_continuous)
 export(scale_linetype_discrete)
 export(scale_linetype_identity)
 export(scale_linetype_manual)
+export(scale_linewidth)
+export(scale_linewidth_binned)
+export(scale_linewidth_continuous)
+export(scale_linewidth_date)
+export(scale_linewidth_datetime)
+export(scale_linewidth_discrete)
+export(scale_linewidth_ordinal)
 export(scale_radius)
 export(scale_shape)
 export(scale_shape_binned)

NEWS.md

@@ -1,5 +1,10 @@
 # ggplot2 (development version)
 
+* A `linewidth` aesthetic has been introduced and supersedes the `size` 
+  aesthetic for scaling the width of lines in line based geoms. `size` will 
+  remain functioning but deprecated for these geoms and it is recommended to 
+  update all code to reflect the new aesthetic (@thomasp85, #3672)
+
 * Secondary axis ticks are now positioned more precisely, removing small visual
   artefacts with alignment between grid and ticks (@thomasp85, #3576)
 

R/geom-.r

@@ -108,6 +108,11 @@ Geom <- ggproto("Geom",
 
   # Combine data with defaults and set aesthetics from parameters
   use_defaults = function(self, data, params = list(), modifiers = aes()) {
+    # Inherit size as linewidth if no linewidth aesthetic and param exist
+    if (self$rename_size && is.null(data$linewidth) && is.null(params$linewidth)) {
+      data$linewidth <- data$size
+      params$linewidth <- params$size
+    }
     # Fill in missing aesthetics with their defaults
     missing_aes <- setdiff(names(self$default_aes), names(data))
 
@@ -187,7 +192,10 @@ Geom <- ggproto("Geom",
       required_aes <- unlist(strsplit(self$required_aes, '|', fixed = TRUE))
     }
     c(union(required_aes, names(self$default_aes)), self$optional_aes, "group")
-  }
+  },
+
+  # Should the geom rename size to linewidth?
+  rename_size = FALSE
 
 )
 

R/geom-abline.r

@@ -22,7 +22,7 @@ NULL
 #' @section Aesthetics:
 #' These geoms are drawn using with [geom_line()] so support the
 #' same aesthetics: `alpha`, `colour`, `linetype` and
-#' `size`. They also each have aesthetics that control the position of
+#' `linewidth`. They also each have aesthetics that control the position of
 #' the line:
 #'
 #'   - `geom_vline()`: `xintercept`
@@ -141,8 +141,10 @@ GeomAbline <- ggproto("GeomAbline", Geom,
     GeomSegment$draw_panel(unique(data), panel_params, coord, lineend = lineend)
   },
 
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, alpha = NA),
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, alpha = NA),
   required_aes = c("slope", "intercept"),
 
-  draw_key = draw_key_abline
+  draw_key = draw_key_abline,
+
+  rename_size = TRUE
 )

R/geom-boxplot.r

@@ -223,7 +223,7 @@ GeomBoxplot <- ggproto("GeomBoxplot", Geom,
 
     common <- list(
       colour = data$colour,
-      size = data$size,
+      linewidth = data$linewidth,
       linetype = data$linetype,
       fill = alpha(data$fill, data$alpha),
       group = data$group
@@ -293,8 +293,10 @@ GeomBoxplot <- ggproto("GeomBoxplot", Geom,
 
   draw_key = draw_key_boxplot,
 
-  default_aes = aes(weight = 1, colour = "grey20", fill = "white", size = 0.5,
-    alpha = NA, shape = 19, linetype = "solid"),
+  default_aes = aes(weight = 1, colour = "grey20", fill = "white", size = NULL,
+    alpha = NA, shape = 19, linetype = "solid", linewidth = 0.5),
 
-  required_aes = c("x|y", "lower|xlower", "upper|xupper", "middle|xmiddle", "ymin|xmin", "ymax|xmax")
+  required_aes = c("x|y", "lower|xlower", "upper|xupper", "middle|xmiddle", "ymin|xmin", "ymax|xmax"),
+
+  rename_size = TRUE
 )

R/geom-col.r

@@ -66,5 +66,7 @@ GeomCol <- ggproto("GeomCol", GeomRect,
       lineend = lineend,
       linejoin = linejoin
     )
-  }
+  },
+
+  rename_size = TRUE
 )

R/geom-contour.r

@@ -127,7 +127,7 @@ GeomContour <- ggproto("GeomContour", GeomPath,
   default_aes = aes(
     weight = 1,
     colour = "#3366FF",
-    size = 0.5,
+    linewidth = 0.5,
     linetype = 1,
     alpha = NA
   )

R/geom-crossbar.r

@@ -40,7 +40,7 @@ GeomCrossbar <- ggproto("GeomCrossbar", Geom,
     GeomErrorbar$setup_data(data, params)
   },
 
-  default_aes = aes(colour = "black", fill = NA, size = 0.5, linetype = 1,
+  default_aes = aes(colour = "black", fill = NA, linewidth = 0.5, linetype = 1,
     alpha = NA),
 
   required_aes = c("x", "y", "ymin|xmin", "ymax|xmax"),
@@ -52,7 +52,7 @@ GeomCrossbar <- ggproto("GeomCrossbar", Geom,
                         flipped_aes = FALSE) {
     data <- flip_data(data, flipped_aes)
 
-    middle <- transform(data, x = xmin, xend = xmax, yend = y, size = size * fatten, alpha = NA)
+    middle <- transform(data, x = xmin, xend = xmax, yend = y, linewidth = linewidth * fatten, alpha = NA)
 
     has_notch <- !is.null(data$ynotchlower) && !is.null(data$ynotchupper) &&
       !is.na(data$ynotchlower) && !is.na(data$ynotchupper)
@@ -82,7 +82,7 @@ GeomCrossbar <- ggproto("GeomCrossbar", Geom,
         ),
         alpha = rep(data$alpha, 11),
         colour = rep(data$colour, 11),
-        size = rep(data$size, 11),
+        linewidth = rep(data$linewidth, 11),
         linetype = rep(data$linetype, 11),
         fill = rep(data$fill, 11),
         group = rep(seq_len(nrow(data)), 11)
@@ -94,7 +94,7 @@ GeomCrossbar <- ggproto("GeomCrossbar", Geom,
         y = c(data$ymax, data$ymin, data$ymin, data$ymax, data$ymax),
         alpha = rep(data$alpha, 5),
         colour = rep(data$colour, 5),
-        size = rep(data$size, 5),
+        linewidth = rep(data$linewidth, 5),
         linetype = rep(data$linetype, 5),
         fill = rep(data$fill, 5),
         group = rep(seq_len(nrow(data)), 5) # each bar forms it's own group

R/geom-curve.r

@@ -40,7 +40,7 @@ geom_curve <- function(mapping = NULL, data = NULL,
 #' @usage NULL
 #' @export
 GeomCurve <- ggproto("GeomCurve", GeomSegment,
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, alpha = NA),
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, alpha = NA),
   draw_panel = function(data, panel_params, coord, curvature = 0.5, angle = 90,
                         ncp = 5, arrow = NULL, arrow.fill = NULL, lineend = "butt", na.rm = FALSE) {
 
@@ -60,7 +60,7 @@ GeomCurve <- ggproto("GeomCurve", GeomSegment,
       gp = gpar(
         col = alpha(trans$colour, trans$alpha),
         fill = alpha(arrow.fill, trans$alpha),
-        lwd = trans$size * .pt,
+        lwd = trans$linewidth * .pt,
         lty = trans$linetype,
         lineend = lineend),
       arrow = arrow

R/geom-density2d.r

@@ -104,7 +104,7 @@ geom_density2d <- geom_density_2d
 #' @usage NULL
 #' @export
 GeomDensity2d <- ggproto("GeomDensity2d", GeomPath,
-  default_aes = aes(colour = "#3366FF", size = 0.5, linetype = 1, alpha = NA)
+  default_aes = aes(colour = "#3366FF", linewidth = 0.5, linetype = 1, alpha = NA)
 )
 
 #' @export

R/geom-errorbar.r

@@ -28,7 +28,7 @@ geom_errorbar <- function(mapping = NULL, data = NULL,
 #' @usage NULL
 #' @export
 GeomErrorbar <- ggproto("GeomErrorbar", Geom,
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, width = 0.5,
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, width = 0.5,
     alpha = NA),
 
   draw_key = draw_key_path,
@@ -61,12 +61,14 @@ GeomErrorbar <- ggproto("GeomErrorbar", Geom,
       y = y,
       colour = rep(data$colour, each = 8),
       alpha = rep(data$alpha, each = 8),
-      size = rep(data$size, each = 8),
+      linewidth = rep(data$linewidth, each = 8),
       linetype = rep(data$linetype, each = 8),
       group = rep(1:(nrow(data)), each = 8),
       row.names = 1:(nrow(data) * 8)
     ))
     data <- flip_data(data, flipped_aes)
     GeomPath$draw_panel(data, panel_params, coord, lineend = lineend)
-  }
+  },
+
+  rename_size = TRUE
 )

R/geom-errorbarh.r

@@ -51,7 +51,7 @@ geom_errorbarh <- function(mapping = NULL, data = NULL,
 #' @usage NULL
 #' @export
 GeomErrorbarh <- ggproto("GeomErrorbarh", Geom,
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, height = 0.5,
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, height = 0.5,
     alpha = NA),
 
   draw_key = draw_key_path,
@@ -73,10 +73,12 @@ GeomErrorbarh <- ggproto("GeomErrorbarh", Geom,
       y = as.vector(rbind(data$ymin, data$ymax, NA, data$y,    data$y,    NA, data$ymin, data$ymax)),
       colour = rep(data$colour, each = 8),
       alpha = rep(data$alpha, each = 8),
-      size = rep(data$size, each = 8),
+      linewidth = rep(data$linewidth, each = 8),
       linetype = rep(data$linetype, each = 8),
       group = rep(1:(nrow(data)), each = 8),
       row.names = 1:(nrow(data) * 8)
     )), panel_params, coord, lineend = lineend)
-  }
+  },
+
+  rename_size = TRUE
 )

R/geom-hex.r

@@ -90,7 +90,7 @@ GeomHex <- ggproto("GeomHex", Geom,
       gp = gpar(
         col = coords$colour,
         fill = alpha(coords$fill, coords$alpha),
-        lwd = coords$size * .pt,
+        lwd = coords$linewidth * .pt,
         lty = coords$linetype,
         lineend = lineend,
         linejoin = linejoin,
@@ -106,12 +106,14 @@ GeomHex <- ggproto("GeomHex", Geom,
   default_aes = aes(
     colour = NA,
     fill = "grey50",
-    size = 0.5,
+    linewidth = 0.5,
     linetype = 1,
     alpha = NA
   ),
 
-  draw_key = draw_key_polygon
+  draw_key = draw_key_polygon,
+
+  rename_size = TRUE
 )
 
 

R/geom-hline.r

@@ -55,8 +55,10 @@ GeomHline <- ggproto("GeomHline", Geom,
     GeomSegment$draw_panel(unique(data), panel_params, coord, lineend = lineend)
   },
 
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, alpha = NA),
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, alpha = NA),
   required_aes = "yintercept",
 
-  draw_key = draw_key_path
+  draw_key = draw_key_path,
+
+  rename_size = TRUE
 )

R/geom-linerange.r

@@ -91,7 +91,7 @@ geom_linerange <- function(mapping = NULL, data = NULL,
 #' @usage NULL
 #' @export
 GeomLinerange <- ggproto("GeomLinerange", Geom,
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, alpha = NA),
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, alpha = NA),
 
   draw_key = draw_key_linerange,
 
@@ -118,5 +118,7 @@ GeomLinerange <- ggproto("GeomLinerange", Geom,
     data <- transform(data, xend = x, y = ymin, yend = ymax)
     data <- flip_data(data, flipped_aes)
     ggname("geom_linerange", GeomSegment$draw_panel(data, panel_params, coord, lineend = lineend))
-  }
+  },
+
+  rename_size = TRUE
 )

R/geom-map.r

@@ -149,7 +149,7 @@ GeomMap <- ggproto("GeomMap", GeomPolygon,
       gp = gpar(
         col = data$colour,
         fill = alpha(data$fill, data$alpha),
-        lwd = data$size * .pt,
+        lwd = data$linewidth * .pt,
         lineend = lineend,
         linejoin = linejoin,
         linemitre = linemitre

R/geom-path.r

@@ -130,12 +130,12 @@ geom_path <- function(mapping = NULL, data = NULL,
 GeomPath <- ggproto("GeomPath", Geom,
   required_aes = c("x", "y"),
 
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, alpha = NA),
+  default_aes = aes(colour = "black", linewidth = 0.5, linetype = 1, alpha = NA),
 
   handle_na = function(self, data, params) {
     # Drop missing values at the start or end of a line - can't drop in the
     # middle since you expect those to be shown by a break in the line
-    complete <- stats::complete.cases(data[c("x", "y", "size", "colour", "linetype")])
+    complete <- stats::complete.cases(data[c("x", "y", "linewidth", "colour", "linetype")])
     kept <- stats::ave(complete, data$group, FUN = keep_mid_true)
     data <- data[kept, ]
 
@@ -170,7 +170,7 @@ GeomPath <- ggproto("GeomPath", Geom,
       linetype <- unique(df$linetype)
       new_data_frame(list(
         solid = identical(linetype, 1) || identical(linetype, "solid"),
-        constant = nrow(unique(df[, c("alpha", "colour","size", "linetype")])) == 1
+        constant = nrow(unique(df[, c("alpha", "colour","linewidth", "linetype")])) == 1
       ), n = 1)
     })
     solid_lines <- all(attr$solid)
@@ -192,7 +192,7 @@ GeomPath <- ggproto("GeomPath", Geom,
         gp = gpar(
           col = alpha(munched$colour, munched$alpha)[!end],
           fill = alpha(munched$colour, munched$alpha)[!end],
-          lwd = munched$size[!end] * .pt,
+          lwd = munched$linewidth[!end] * .pt,
           lty = munched$linetype[!end],
           lineend = lineend,
           linejoin = linejoin,
@@ -207,7 +207,7 @@ GeomPath <- ggproto("GeomPath", Geom,
         gp = gpar(
           col = alpha(munched$colour, munched$alpha)[start],
           fill = alpha(munched$colour, munched$alpha)[start],
-          lwd = munched$size[start] * .pt,
+          lwd = munched$linewidth[start] * .pt,
           lty = munched$linetype[start],
           lineend = lineend,
           linejoin = linejoin,
@@ -217,7 +217,9 @@ GeomPath <- ggproto("GeomPath", Geom,
     }
   },
 
-  draw_key = draw_key_path
+  draw_key = draw_key_path,
+
+  rename_size = TRUE
 )
 
 # Trim false values from left and right: keep all values from

R/geom-pointrange.r

@@ -30,8 +30,8 @@ geom_pointrange <- function(mapping = NULL, data = NULL,
 #' @usage NULL
 #' @export
 GeomPointrange <- ggproto("GeomPointrange", Geom,
-  default_aes = aes(colour = "black", size = 0.5, linetype = 1, shape = 19,
-    fill = NA, alpha = NA, stroke = 1),
+  default_aes = aes(colour = "black", size = 0.5, linewidth = 0.5, linetype = 1,
+                    shape = 19, fill = NA, alpha = NA, stroke = 1),
 
   draw_key = draw_key_pointrange,