v0.5.1

yjunechoe · Apr 17, 2022 · ba96242 · ba96242
1 parent 16f7220
commit ba96242
Show file tree

Hide file tree

Showing 51 changed files with 282 additions and 69 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: ggtrace
 Type: Package
 Title: Programmatically explore, debug, and manipulate ggplot internals
-Version: 0.5.0.9000
+Version: 0.5.1
 Authors@R: c(
       person(given = "June",
            family = "Choe",

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,8 @@
 # ggtrace (development version)
 
-- `cond` argument of workflow functions now support integer shorthand for conditioning on the counter. E.g., `cond = 1L` is converted to `cond = quote(._counter_ == 1L)`
+## ggtrace 0.5.1
+
+- `cond` argument of workflow functions now support integer shorthand for conditioning on the counter. E.g., `cond = 1L` is converted to `cond = quote(._counter_ == 1L)`. Multi-length integer vector is supported for highjack workflows.
 
 ## ggtrace 0.5.0
 

diff --git a/R/workflows-highjack.R b/R/workflows-highjack.R
@@ -52,7 +52,7 @@
 #'
 ggtrace_highjack_args <- function(x, method, cond = 1L, values, draw = TRUE) {
 
-  cond <- resolve_cond(cond)
+  cond <- resolve_cond(cond, multiple = TRUE)
 
   wrapper_env <- rlang::current_env()
   ._counter_ <- 0L
@@ -177,7 +177,7 @@ ggtrace_highjack_args <- function(x, method, cond = 1L, values, draw = TRUE) {
 #'
 ggtrace_highjack_return <- function(x, method, cond = 1L, value = quote(returnValue()), draw = TRUE) {
 
-  cond <- resolve_cond(cond)
+  cond <- resolve_cond(cond, multiple = TRUE)
 
   wrapper_env <- rlang::current_env()
   ._counter_ <- 0L

diff --git a/R/workflows-utils.R b/R/workflows-utils.R
@@ -25,13 +25,13 @@ print.ggtrace_highjacked <- function(x, ...) {
   ggdraw_silent(x)
 }
 
-resolve_cond <- function(x) {
+resolve_cond <- function(x, multiple = FALSE) {
   if (is.numeric(x)) {
-    if (length(x) > 1L) {
-      rlang::warn("`cond` is length > 1 and only the first element will be used")
-      x <- x[1]
+    if (multiple && length(x) > 1L) {
+      x <- rlang::expr(._counter_ %in% !!as.integer(x))
+    } else {
+      x <- rlang::expr(._counter_ == !!as.integer(x))
     }
-    x <- rlang::expr(._counter_ == !!as.integer(x))
   }
   x
 }
diff --git a/README.Rmd b/README.Rmd
@@ -28,7 +28,7 @@ knitr::opts_chunk$set(
 #### **Programmatically explore, debug, and manipulate ggplot internals**
 
 <!-- badges: start -->
-[![](https://img.shields.io/badge/devel%20version-0.5.0.9000-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
+[![](https://img.shields.io/badge/devel%20version-0.5.1-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
 <!-- badges: end -->
 
 ### **Installation**
@@ -41,7 +41,7 @@ remotes::install_github("yjunechoe/ggtrace")
 ```
 
 ```{r setup}
-library(ggtrace) # v0.5.0.9000
+library(ggtrace) # v0.5.1
 ```
 
 More on the 📦 package website: [https://yjunechoe.github.io/ggtrace](https://yjunechoe.github.io/ggtrace)
@@ -515,3 +515,66 @@ with_ggtrace(
   
 )
 ```
+
+## **Case study: Data-driven legends**
+
+Suppose we want to change the fill legend key from squares to the actual violins drawn for each category:
+
+```{r}
+violin_plot <- dplyr::starwars %>% 
+  filter(species == "Human", !is.na(height)) %>% 
+  ggplot(aes(gender, height)) +
+  geom_violin(aes(fill = gender)) +
+  theme(
+    legend.key.size = unit(1, "in"),
+    legend.key = element_rect(color = "grey", fill = NA)
+  )
+
+violin_plot
+```
+
+We know that each violin is drawn by `GeomViolin$draw_group`, called for each group in the plot.
+
+```{r}
+ggtrace_inspect_n(violin_plot, GeomViolin$draw_group)
+```
+
+Let's grab the plotted violins with `ggtrace_inspect_return()`
+
+```{r}
+violins <- lapply(1:2, ggtrace_inspect_return, x = violin_plot, method = GeomViolin$draw_group)
+violins
+```
+
+Then, we can use `ggtrace_highjack_return()` to highjack the return value of the key drawing method `GeomViolin$draw_key` such that it returns the output from the `draw_group` method instead. We set `cond = 1:2` and value to `substitute(violins[[._counter_]])` so that the `draw_key` method returns the first violin as the first legend key, and the second violin as the second legend key.
+
+```{r}
+ggtrace_highjack_return(
+  violin_plot,
+  GeomViolin$draw_key,
+  cond = 1:2,
+  value = substitute(violins[[._counter_]])
+)
+```
+
+Note that violins are drawn with respect to the panel coordinate system, because that's how the `draw_group` method does things. We create and use the function `center_grob()` to center them before they're passed to the `value` argument of `ggtrace_highjack_return`.
+
+```{r}
+library(grid)
+center_grob <- function(grob) {
+  x_range <- range(unclass(grob$x))
+  y_range <- range(unclass(grob$y))
+  editGrob(grob, vp = viewport(
+    xscale = x_range, yscale = y_range,
+    width = diff(x_range), height = diff(y_range)
+  ))
+}
+violins_stretched <- lapply(violins, center_grob)
+
+ggtrace_highjack_return(
+  violin_plot,
+  GeomViolin$draw_key,
+  cond = 1:2,
+  value = substitute(violins_stretched[[._counter_]])
+)
+```
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 <!-- badges: start -->
 
-[![](https://img.shields.io/badge/devel%20version-0.5.0.9000-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
+[![](https://img.shields.io/badge/devel%20version-0.5.1-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
 <!-- badges: end -->
 
 ### **Installation**
@@ -17,7 +17,7 @@ You can install the development version from
     # install.packages("remotes")
     remotes::install_github("yjunechoe/ggtrace")
 
-    library(ggtrace) # v0.5.0.9000
+    library(ggtrace) # v0.5.1
 
 More on the 📦 package website: <https://yjunechoe.github.io/ggtrace>
 
@@ -632,3 +632,78 @@ as well!
     )
 
 <img src="man/figures/README-unnamed-chunk-31-1.png" width="100%" />
+
+## **Case study: Data-driven legends**
+
+Suppose we want to change the fill legend key from squares to the actual
+violins drawn for each category:
+
+    violin_plot <- dplyr::starwars %>% 
+      filter(species == "Human", !is.na(height)) %>% 
+      ggplot(aes(gender, height)) +
+      geom_violin(aes(fill = gender)) +
+      theme(
+        legend.key.size = unit(1, "in"),
+        legend.key = element_rect(color = "grey", fill = NA)
+      )
+
+    violin_plot
+
+<img src="man/figures/README-unnamed-chunk-32-1.png" width="100%" />
+
+We know that each violin is drawn by `GeomViolin$draw_group`, called for
+each group in the plot.
+
+    ggtrace_inspect_n(violin_plot, GeomViolin$draw_group)
+    #> [1] 2
+
+Let’s grab the plotted violins with `ggtrace_inspect_return()`
+
+    violins <- lapply(1:2, ggtrace_inspect_return, x = violin_plot, method = GeomViolin$draw_group)
+    violins
+    #> [[1]]
+    #> polygon[geom_violin.polygon.2816] 
+    #> 
+    #> [[2]]
+    #> polygon[geom_violin.polygon.2880]
+
+Then, we can use `ggtrace_highjack_return()` to highjack the return
+value of the key drawing method `GeomViolin$draw_key` such that it
+returns the output from the `draw_group` method instead. We set
+`cond = 1:2` and value to `substitute(violins[[._counter_]])` so that
+the `draw_key` method returns the first violin as the first legend key,
+and the second violin as the second legend key.
+
+    ggtrace_highjack_return(
+      violin_plot,
+      GeomViolin$draw_key,
+      cond = 1:2,
+      value = substitute(violins[[._counter_]])
+    )
+
+<img src="man/figures/README-unnamed-chunk-35-1.png" width="100%" />
+
+Note that violins are drawn with respect to the panel coordinate system,
+because that’s how the `draw_group` method does things. We create and
+use the function `center_grob()` to center them before they’re passed to
+the `value` argument of `ggtrace_highjack_return`.
+
+    library(grid)
+    center_grob <- function(grob) {
+      x_range <- range(unclass(grob$x))
+      y_range <- range(unclass(grob$y))
+      editGrob(grob, vp = viewport(
+        xscale = x_range, yscale = y_range,
+        width = diff(x_range), height = diff(y_range)
+      ))
+    }
+    violins_stretched <- lapply(violins, center_grob)
+
+    ggtrace_highjack_return(
+      violin_plot,
+      GeomViolin$draw_key,
+      cond = 1:2,
+      value = substitute(violins_stretched[[._counter_]])
+    )
+
+<img src="man/figures/README-unnamed-chunk-36-1.png" width="100%" />
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/FAQ.html b/docs/articles/FAQ.html
diff --git a/docs/articles/casestudy-after_scale.html b/docs/articles/casestudy-after_scale.html
diff --git a/docs/articles/casestudy-ggxmean.html b/docs/articles/casestudy-ggxmean.html
diff --git a/docs/articles/comparisons.html b/docs/articles/comparisons.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/intro.html b/docs/articles/intro.html
diff --git a/docs/articles/showcase-aes_evaluation.html b/docs/articles/showcase-aes_evaluation.html
diff --git a/docs/articles/showcase-ggplot_build.html b/docs/articles/showcase-ggplot_build.html
diff --git a/docs/articles/technical-details.html b/docs/articles/technical-details.html