Rename ggpar() to gg_par() (#5899)

teunbrand · web-flow · commit e3a4dafa50c6 · 2024-05-24T08:55:53.000+02:00
* rename `ggpar()` to `gparam()`

* rename to `gg_par()`
diff --git a/NAMESPACE b/NAMESPACE
@@ -429,7 +429,7 @@ export(get_layer_grob)
 export(get_panel_scales)
 export(get_theme)
 export(gg_dep)
-export(ggpar)
+export(gg_par)
 export(ggplot)
 export(ggplotGrob)
 export(ggplot_add)
diff --git a/NEWS.md b/NEWS.md
@@ -61,7 +61,7 @@
   (@teunbrand, #5756).
 * Fixed bug in `guide_custom()` that would throw error with `theme_void()` 
   (@teunbrand, #5856).
-* New helper function `ggpar()` to translate ggplot2's interpretation of 
+* New helper function `gg_par()` to translate ggplot2's interpretation of 
   graphical parameters to {grid}'s interpretation (@teunbrand, #5866).
 * `scale_{x/y}_discrete()` can now accept a `sec.axis`. It is recommended to
   only use `dup_axis()` to set custom breaks or labels, as discrete variables 
diff --git a/R/annotation-logticks.R b/R/annotation-logticks.R
@@ -175,14 +175,14 @@ GeomLogticks <- ggproto("GeomLogticks", Geom,
         ticks$x_b <- with(data, segmentsGrob(
           x0 = unit(xticks$x, "native"), x1 = unit(xticks$x, "native"),
           y0 = unit(xticks$start, "cm"), y1 = unit(xticks$end, "cm"),
-          gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
+          gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
         ))
       }
       if (grepl("t", sides) && nrow(xticks) > 0) {
         ticks$x_t <- with(data, segmentsGrob(
           x0 = unit(xticks$x, "native"), x1 = unit(xticks$x, "native"),
           y0 = unit(1, "npc") - unit(xticks$start, "cm"), y1 = unit(1, "npc") - unit(xticks$end, "cm"),
-          gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
+          gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
         ))
       }
     }
@@ -213,14 +213,14 @@ GeomLogticks <- ggproto("GeomLogticks", Geom,
         ticks$y_l <- with(data, segmentsGrob(
           y0 = unit(yticks$y, "native"), y1 = unit(yticks$y, "native"),
           x0 = unit(yticks$start, "cm"), x1 = unit(yticks$end, "cm"),
-          gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
+          gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
         ))
       }
       if (grepl("r", sides) && nrow(yticks) > 0) {
         ticks$y_r <- with(data, segmentsGrob(
           y0 = unit(yticks$y, "native"), y1 = unit(yticks$y, "native"),
           x0 = unit(1, "npc") - unit(yticks$start, "cm"), x1 = unit(1, "npc") - unit(yticks$end, "cm"),
-          gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
+          gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)
         ))
       }
     }
diff --git a/R/annotation-map.R b/R/annotation-map.R
@@ -95,7 +95,7 @@ GeomAnnotationMap <- ggproto("GeomAnnotationMap", GeomMap,
 
     polygonGrob(coords$x, coords$y, default.units = "native",
       id = grob_id,
-      gp = ggpar(
+      gp = gg_par(
         col = data$colour, fill = alpha(data$fill, data$alpha),
         lwd = data$linewidth)
       )
diff --git a/R/coord-radial.R b/R/coord-radial.R
@@ -326,7 +326,7 @@ CoordRadial <- ggproto("CoordRadial", Coord,
         y = c(Inf, -Inf, -Inf,  Inf)
       )
       background <- coord_munch(self, background, panel_params, is_closed = TRUE)
-      bg_gp <- ggpar(
+      bg_gp <- gg_par(
         lwd = bg_element$linewidth,
         col = bg_element$colour, fill = bg_element$fill,
         lty = bg_element$linetype
diff --git a/R/coord-sf.R b/R/coord-sf.R
@@ -335,7 +335,7 @@ CoordSf <- ggproto("CoordSf", CoordCartesian,
     if (inherits(el, "element_blank")) {
       grobs <- list(element_render(theme, "panel.background"))
     } else {
-      line_gp <- ggpar(
+      line_gp <- gg_par(
         col = el$colour,
         lwd = el$linewidth,
         lty = el$linetype
diff --git a/R/geom-curve.R b/R/geom-curve.R
@@ -62,7 +62,7 @@ GeomCurve <- ggproto("GeomCurve", GeomSegment,
       default.units = "native",
       curvature = curvature, angle = angle, ncp = ncp,
       square = FALSE, squareShape = 1, inflect = FALSE, open = TRUE,
-      gp = ggpar(
+      gp = gg_par(
         col = alpha(trans$colour, trans$alpha),
         fill = alpha(arrow.fill, trans$alpha),
         lwd = trans$linewidth,
diff --git a/R/geom-dotplot.R b/R/geom-dotplot.R
@@ -293,10 +293,10 @@ GeomDotplot <- ggproto("GeomDotplot", Geom,
       dotstackGrob(stackaxis = stackaxis, x = tdata$x, y = tdata$y, dotdia = dotdianpc,
                   stackposition = tdata$stackpos, stackdir = stackdir, stackratio = stackratio,
                   default.units = "npc",
-                  gp = ggpar(col = alpha(tdata$colour, tdata$alpha),
-                            fill = fill_alpha(tdata$fill, tdata$alpha),
-                            lwd = tdata$stroke / .pt, lty = tdata$linetype,
-                            lineend = lineend))
+                  gp = gg_par(col = alpha(tdata$colour, tdata$alpha),
+                              fill = fill_alpha(tdata$fill, tdata$alpha),
+                              lwd = tdata$stroke / .pt, lty = tdata$linetype,
+                              lineend = lineend))
     )
   },
 
diff --git a/R/geom-hex.R b/R/geom-hex.R
@@ -89,7 +89,7 @@ GeomHex <- ggproto("GeomHex", Geom,
 
     ggname("geom_hex", polygonGrob(
       coords$x, coords$y,
-      gp = ggpar(
+      gp = gg_par(
         col = data$colour,
         fill = fill_alpha(data$fill, data$alpha),
         lwd = data$linewidth,
diff --git a/R/geom-label.R b/R/geom-label.R
@@ -90,14 +90,14 @@ GeomLabel <- ggproto("GeomLabel", Geom,
         padding = label.padding,
         r = label.r,
         angle = row$angle,
-        text.gp = ggpar(
+        text.gp = gg_par(
           col = row$colour,
           fontsize = row$size * size.unit,
           fontfamily = row$family,
           fontface = row$fontface,
           lineheight = row$lineheight
         ),
-        rect.gp = ggpar(
+        rect.gp = gg_par(
           col = if (isTRUE(all.equal(label.size, 0))) NA else row$colour,
           fill = fill_alpha(row$fill, row$alpha),
           lwd = label.size
@@ -115,7 +115,7 @@ GeomLabel <- ggproto("GeomLabel", Geom,
 labelGrob <- function(label, x = unit(0.5, "npc"), y = unit(0.5, "npc"),
                       just = "center", padding = unit(0.25, "lines"), r = unit(0.1, "snpc"),
                       angle = NULL, default.units = "npc", name = NULL,
-                      text.gp = gpar(), rect.gp = ggpar(fill = "white"), vp = NULL) {
+                      text.gp = gpar(), rect.gp = gg_par(fill = "white"), vp = NULL) {
 
   if (length(label) != 1) {
     cli::cli_abort("{.arg label} must be of length 1.")
@@ -130,7 +130,7 @@ labelGrob <- function(label, x = unit(0.5, "npc"), y = unit(0.5, "npc"),
     vp <- viewport(
       angle = angle, x = x, y = y,
       width = unit(0, "cm"), height = unit(0, "cm"),
-      gp = ggpar(fontsize = text.gp$fontsize)
+      gp = gg_par(fontsize = text.gp$fontsize)
     )
     x <- unit(rep(0.5, length(x)), "npc")
     y <- unit(rep(0.5, length(y)), "npc")
diff --git a/R/geom-map.R b/R/geom-map.R
@@ -144,7 +144,7 @@ GeomMap <- ggproto("GeomMap", GeomPolygon,
     data <- data[data_rows, , drop = FALSE]
 
     polygonGrob(coords$x, coords$y, default.units = "native", id = grob_id,
-      gp = ggpar(
+      gp = gg_par(
         col = data$colour,
         fill = fill_alpha(data$fill, data$alpha),
         lwd = data$linewidth,
diff --git a/R/geom-path.R b/R/geom-path.R
@@ -206,7 +206,7 @@ GeomPath <- ggproto("GeomPath", Geom,
       segmentsGrob(
         munched$x[!end], munched$y[!end], munched$x[!start], munched$y[!start],
         default.units = "native", arrow = arrow,
-        gp = ggpar(
+        gp = gg_par(
           col = alpha(munched$colour, munched$alpha)[!end],
           fill = alpha(munched$fill, munched$alpha)[!end],
           lwd = munched$linewidth[!end],
@@ -221,7 +221,7 @@ GeomPath <- ggproto("GeomPath", Geom,
       polylineGrob(
         munched$x, munched$y, id = id,
         default.units = "native", arrow = arrow,
-        gp = ggpar(
+        gp = gg_par(
           col = alpha(munched$colour, munched$alpha)[start],
           fill = alpha(munched$fill, munched$alpha)[start],
           lwd = munched$linewidth[start],
diff --git a/R/geom-point.R b/R/geom-point.R
@@ -149,7 +149,7 @@ GeomPoint <- ggproto("GeomPoint", Geom,
       pointsGrob(
         coords$x, coords$y,
         pch = coords$shape,
-        gp = ggpar(
+        gp = gg_par(
           col = alpha(coords$colour, coords$alpha),
           fill = fill_alpha(coords$fill, coords$alpha),
           pointsize = coords$size,
diff --git a/R/geom-polygon.R b/R/geom-polygon.R
@@ -130,7 +130,7 @@ GeomPolygon <- ggproto("GeomPolygon", Geom,
         polygonGrob(
           munched$x, munched$y, default.units = "native",
           id = munched$group,
-          gp = ggpar(
+          gp = gg_par(
             col = first_rows$colour,
             fill = fill_alpha(first_rows$fill, first_rows$alpha),
             lwd = first_rows$linewidth,
@@ -161,7 +161,7 @@ GeomPolygon <- ggproto("GeomPolygon", Geom,
           munched$x, munched$y, default.units = "native",
           id = id, pathId = munched$group,
           rule = rule,
-          gp = ggpar(
+          gp = gg_par(
             col = first_rows$colour,
             fill = fill_alpha(first_rows$fill, first_rows$alpha),
             lwd = first_rows$linewidth,
diff --git a/R/geom-rect.R b/R/geom-rect.R
@@ -57,7 +57,7 @@ GeomRect <- ggproto("GeomRect", Geom,
         height = coords$ymax - coords$ymin,
         default.units = "native",
         just = c("left", "top"),
-        gp = ggpar(
+        gp = gg_par(
           col = coords$colour,
           fill = fill_alpha(coords$fill, coords$alpha),
           lwd = coords$linewidth,
diff --git a/R/geom-ribbon.R b/R/geom-ribbon.R
@@ -215,7 +215,7 @@ GeomRibbon <- ggproto("GeomRibbon", Geom,
     g_poly <- polygonGrob(
       munched_poly$x, munched_poly$y, id = munched_poly$id,
       default.units = "native",
-      gp = ggpar(
+      gp = gg_par(
         fill = fill_alpha(aes$fill, aes$alpha),
         col = if (is_full_outline) aes$colour else NA,
         lwd = if (is_full_outline) aes$linewidth else 0,
@@ -246,7 +246,7 @@ GeomRibbon <- ggproto("GeomRibbon", Geom,
     g_lines <- polylineGrob(
       munched_lines$x, munched_lines$y, id = munched_lines$id,
       default.units = "native",
-      gp = ggpar(
+      gp = gg_par(
         col = aes$colour,
         lwd = aes$linewidth,
         lty = aes$linetype,
diff --git a/R/geom-rug.R b/R/geom-rug.R
@@ -108,7 +108,7 @@ GeomRug <- ggproto("GeomRug", Geom,
       list(min = -1 * length, max = unit(1, "npc") + length)
     }
 
-    gp <- ggpar(
+    gp <- gg_par(
       col = alpha(data$colour, data$alpha),
       lty = data$linetype,
       lwd = data$linewidth,
diff --git a/R/geom-segment.R b/R/geom-segment.R
@@ -122,7 +122,7 @@ GeomSegment <- ggproto("GeomSegment", Geom,
       arrow.fill <- arrow.fill %||% coord$colour
       return(segmentsGrob(coord$x, coord$y, coord$xend, coord$yend,
         default.units = "native",
-        gp = ggpar(
+        gp = gg_par(
           col = alpha(coord$colour, coord$alpha),
           fill = alpha(arrow.fill, coord$alpha),
           lwd = coord$linewidth,
diff --git a/R/geom-text.R b/R/geom-text.R
@@ -239,7 +239,7 @@ GeomText <- ggproto("GeomText", Geom,
       data$x, data$y, default.units = "native",
       hjust = data$hjust, vjust = data$vjust,
       rot = data$angle,
-      gp = ggpar(
+      gp = gg_par(
         col = alpha(data$colour, data$alpha),
         fontsize = data$size * size.unit,
         fontfamily = data$family,
diff --git a/R/guide-colorbar.R b/R/guide-colorbar.R
@@ -379,7 +379,7 @@ GuideColourbar <- ggproto(
         vjust = 0, hjust = 0,
         width = width, height = height,
         default.units = "npc",
-        gp = ggpar(col = NA, fill = decor$colour)
+        gp = gg_par(col = NA, fill = decor$colour)
       )
     } else if (params$display == "gradient") {
       check_device("gradients", call = expr(guide_colourbar()))
@@ -394,7 +394,7 @@ GuideColourbar <- ggproto(
         vertical   = list(x1 = unit(0.5, "npc"), x2 = unit(0.5, "npc"))
       )
       gradient <- inject(linearGradient(decor$colour, value, !!!position))
-      grob <- rectGrob(gp = ggpar(fill = gradient, col = NA))
+      grob <- rectGrob(gp = gg_par(fill = gradient, col = NA))
     }
 
     frame <- element_grob(elements$frame, fill = NA)
diff --git a/R/guide-colorsteps.R b/R/guide-colorsteps.R
@@ -204,7 +204,7 @@ GuideColoursteps <- ggproto(
 
     size <- abs(decor$max - decor$min)
     just <- as.numeric(decor$min > decor$max)
-    gp   <- ggpar(col = NA, fill = decor$colour)
+    gp   <- gg_par(col = NA, fill = decor$colour)
     if (params$direction == "vertical") {
       grob <- rectGrob(
         x = 0, y = decor$min,
diff --git a/R/legend-draw.R b/R/legend-draw.R
diff --git a/R/margins.R b/R/margins.R
diff --git a/R/theme-elements.R b/R/theme-elements.R
diff --git a/R/utilities-grid.R b/R/utilities-grid.R
diff --git a/man/gg_par.Rd b/man/gg_par.Rd

Original file line number	Diff line number	Diff line change
`@@ -175,14 +175,14 @@ GeomLogticks <- ggproto("GeomLogticks", Geom,`
`175`	`175`	`ticks$x_b <- with(data, segmentsGrob(`
`176`	`176`	`x0 = unit(xticks$x, "native"), x1 = unit(xticks$x, "native"),`
`177`	`177`	`y0 = unit(xticks$start, "cm"), y1 = unit(xticks$end, "cm"),`
`178`		`- gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
	`178`	`+ gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
`179`	`179`	`))`
`180`	`180`	`}`
`181`	`181`	`if (grepl("t", sides) && nrow(xticks) > 0) {`
`182`	`182`	`ticks$x_t <- with(data, segmentsGrob(`
`183`	`183`	`x0 = unit(xticks$x, "native"), x1 = unit(xticks$x, "native"),`
`184`	`184`	`y0 = unit(1, "npc") - unit(xticks$start, "cm"), y1 = unit(1, "npc") - unit(xticks$end, "cm"),`
`185`		`- gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
	`185`	`+ gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
`186`	`186`	`))`
`187`	`187`	`}`
`188`	`188`	`}`
`@@ -213,14 +213,14 @@ GeomLogticks <- ggproto("GeomLogticks", Geom,`
`213`	`213`	`ticks$y_l <- with(data, segmentsGrob(`
`214`	`214`	`y0 = unit(yticks$y, "native"), y1 = unit(yticks$y, "native"),`
`215`	`215`	`x0 = unit(yticks$start, "cm"), x1 = unit(yticks$end, "cm"),`
`216`		`- gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
	`216`	`+ gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
`217`	`217`	`))`
`218`	`218`	`}`
`219`	`219`	`if (grepl("r", sides) && nrow(yticks) > 0) {`
`220`	`220`	`ticks$y_r <- with(data, segmentsGrob(`
`221`	`221`	`y0 = unit(yticks$y, "native"), y1 = unit(yticks$y, "native"),`
`222`	`222`	`x0 = unit(1, "npc") - unit(yticks$start, "cm"), x1 = unit(1, "npc") - unit(yticks$end, "cm"),`
`223`		`- gp = ggpar(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
	`223`	`+ gp = gg_par(col = alpha(colour, alpha), lty = linetype, lwd = linewidth)`
`224`	`224`	`))`
`225`	`225`	`}`
`226`	`226`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ GeomAnnotationMap <- ggproto("GeomAnnotationMap", GeomMap,`
`95`	`95`
`96`	`96`	`polygonGrob(coords$x, coords$y, default.units = "native",`
`97`	`97`	`id = grob_id,`
`98`		`- gp = ggpar(`
	`98`	`+ gp = gg_par(`
`99`	`99`	`col = data$colour, fill = alpha(data$fill, data$alpha),`
`100`	`100`	`lwd = data$linewidth)`
`101`	`101`	`)`
Original file line number	Diff line number	Diff line change
`@@ -326,7 +326,7 @@ CoordRadial <- ggproto("CoordRadial", Coord,`
`326`	`326`	`y = c(Inf, -Inf, -Inf, Inf)`
`327`	`327`	`)`
`328`	`328`	`background <- coord_munch(self, background, panel_params, is_closed = TRUE)`
`329`		`- bg_gp <- ggpar(`
	`329`	`+ bg_gp <- gg_par(`
`330`	`330`	`lwd = bg_element$linewidth,`
`331`	`331`	`col = bg_element$colour, fill = bg_element$fill,`
`332`	`332`	`lty = bg_element$linetype`