diff --git a/README.Rmd b/README.Rmd index dfc2f96..5719ac9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -50,13 +50,15 @@ More on the 📦 package website: [https://yjunechoe.github.io/ggtrace](https:// `{ggtrace}` embodies an opinionated approach to learning/debugging/hacking `{ggplot2}` internals. I recommend watching the following presentation(s) on `{ggtrace}` before getting started on any kind of code: -- [Talk at rstudio::conf(2022)](https://github.com/yjunechoe/ggtrace-rstudioconf2022). +- [Talk at rstudio::conf(2022)](https://www.youtube.com/watch?v=dUBnitXf5mk&list=PL9HYL-VRX0oTOwqzVtL_q5T8MNrzn0mdH&index=38) (+ accompanying [materials](https://github.com/yjunechoe/ggtrace-rstudioconf2022)). - [Talk at useR! 2022](https://www.youtube.com/watch?v=2JX8zu4QxMg&t=2959s) (+ accompanying [materials](https://github.com/yjunechoe/ggtrace-user2022)). +- [Talk at JSM 2023 (pre-recorded)](https://youtu.be/613Q0j6Kjm0?feature=shared) (+ accompanying [paper](https://yjunechoe.github.io/static/papers/Choe_2022_SublayerGG.pdf)) + You can read the full philosophy behind `{ggtrace}` in the [Getting Started](https://yjunechoe.github.io/ggtrace/articles/getting-started.html) vignette. But broadly speaking, `{ggtrace}` was designed with **three goals** in mind, in order of increasing complexity: -1) To help users understand the design of **sublayer modularity**, allowing them to write more expressive layer code using [delayed aesthetic evaluation](https://ggplot2.tidyverse.org/reference/aes_eval.html) functions. This is a primarily pedagogical goal and outlined in my paper [Sub-layer modularity in the Grammar of Graphics](https://yjunechoe.github.io/static/papers/Choe_2022_SublayerGG.pdf). The family of `layer_*()` extractor functions return snapshots of layer data in the internals, to help develop an accessible mental model of sublayer processes as a data wrangling pipeline. +1) To help users understand the design of **sublayer modularity** and write more expressive layer code using [delayed aesthetic evaluation](https://ggplot2.tidyverse.org/reference/aes_eval.html). This is a primarily pedagogical goal and outlined in my paper [Sub-layer modularity in the Grammar of Graphics](https://yjunechoe.github.io/static/papers/Choe_2022_SublayerGG.pdf). The family of `layer_*()` extractor functions return snapshots of layer data in the internals, to help scaffold a mental model of sublayer processes as a data wrangling pipeline. ![](https://i.imgur.com/OlLmz8r.png) @@ -64,7 +66,7 @@ You can read the full philosophy behind `{ggtrace}` in the [Getting Started](htt ![](https://i.imgur.com/kpTffyw.jpg) -3) To provide a **pseudo-extension mechanism** for `{ggplot2}`, by injecting custom code to hack into the rendering pipeline. This is similar in spirit to [`{gggrid}`](https://www.stat.auckland.ac.nz/~paul/Reports/gggrid/gggrid.html) and [`{gginnards}`](https://github.com/aphalo/gginnards), but with a broader scope (targeting any arbitrary computation) at the cost of reproducibility (may break with even trivial changes to the `{ggplot2}` codebase). This is achieved via the low-level function `ggtrace()` (extending the capabilities of `base::trace()`) and its functional form `with_ggtrace()`. See examples in the [Overview](https://yjunechoe.github.io/ggtrace/articles/overview.html) vignette. +3) To provide a **pseudo-extension mechanism** for `{ggplot2}`, by injecting custom code that highjacks the rendering pipeline. This is similar in spirit to [`{gggrid}`](https://www.stat.auckland.ac.nz/~paul/Reports/gggrid/gggrid.html) and [`{gginnards}`](https://github.com/aphalo/gginnards), but with a broader scope (targeting any arbitrary computation) at some cost to reproducibility (may break with even trivial changes to the `{ggplot2}` codebase). This is achieved via the low-level function `ggtrace()` (which improves upon `base::trace()`) and its functional form `with_ggtrace()`. See examples in the [Overview](https://yjunechoe.github.io/ggtrace/articles/overview.html) vignette. ## **Example usage** diff --git a/README.md b/README.md index 250f042..24b9cbf 100644 --- a/README.md +++ b/README.md @@ -32,28 +32,34 @@ the following presentation(s) on `{ggtrace}` before getting started on any kind of code: - [Talk at - rstudio::conf(2022)](https://github.com/yjunechoe/ggtrace-rstudioconf2022). + rstudio::conf(2022)](https://www.youtube.com/watch?v=dUBnitXf5mk&list=PL9HYL-VRX0oTOwqzVtL_q5T8MNrzn0mdH&index=38) + (+ accompanying + [materials](https://github.com/yjunechoe/ggtrace-rstudioconf2022)). - [Talk at useR! 2022](https://www.youtube.com/watch?v=2JX8zu4QxMg&t=2959s) (+ accompanying [materials](https://github.com/yjunechoe/ggtrace-user2022)). +- [Talk at JSM 2023 + (pre-recorded)](https://youtu.be/613Q0j6Kjm0?feature=shared) (+ + accompanying + [paper](https://yjunechoe.github.io/static/papers/Choe_2022_SublayerGG.pdf)) + You can read the full philosophy behind `{ggtrace}` in the [Getting Started](https://yjunechoe.github.io/ggtrace/articles/getting-started.html) vignette. But broadly speaking, `{ggtrace}` was designed with **three goals** in mind, in order of increasing complexity: -1. To help users understand the design of **sublayer modularity**, - allowing them to write more expressive layer code using [delayed - aesthetic - evaluation](https://ggplot2.tidyverse.org/reference/aes_eval.html) - functions. This is a primarily pedagogical goal and outlined in my - paper [Sub-layer modularity in the Grammar of +1. To help users understand the design of **sublayer modularity** and + write more expressive layer code using [delayed aesthetic + evaluation](https://ggplot2.tidyverse.org/reference/aes_eval.html). + This is a primarily pedagogical goal and outlined in my paper + [Sub-layer modularity in the Grammar of Graphics](https://yjunechoe.github.io/static/papers/Choe_2022_SublayerGG.pdf). The family of `layer_*()` extractor functions return snapshots of - layer data in the internals, to help develop an accessible mental - model of sublayer processes as a data wrangling pipeline. + layer data in the internals, to help scaffold a mental model of + sublayer processes as a data wrangling pipeline. ![](https://i.imgur.com/OlLmz8r.png) @@ -67,23 +73,24 @@ goals** in mind, in order of increasing complexity: ![](https://i.imgur.com/kpTffyw.jpg) 3. To provide a **pseudo-extension mechanism** for `{ggplot2}`, by - injecting custom code to hack into the rendering pipeline. This is + injecting custom code that highjacks the rendering pipeline. This is similar in spirit to [`{gggrid}`](https://www.stat.auckland.ac.nz/~paul/Reports/gggrid/gggrid.html) and [`{gginnards}`](https://github.com/aphalo/gginnards), but with a - broader scope (targeting any arbitrary computation) at the cost of + broader scope (targeting any arbitrary computation) at some cost to reproducibility (may break with even trivial changes to the `{ggplot2}` codebase). This is achieved via the low-level function - `ggtrace()` (extending the capabilities of `base::trace()`) and its - functional form `with_ggtrace()`. See examples in the + `ggtrace()` (which improves upon `base::trace()`) and its functional + form `with_ggtrace()`. See examples in the [Overview](https://yjunechoe.github.io/ggtrace/articles/overview.html) vignette. ## **Example usage** library(ggplot2) + #> Warning: package 'ggplot2' was built under R version 4.3.1 packageVersion("ggplot2") - #> [1] '3.4.2' + #> [1] '3.4.3' ### 1) **Inspect sub-layer data** diff --git a/docs/index.html b/docs/index.html index c0b409b..17a26ae 100644 --- a/docs/index.html +++ b/docs/index.html @@ -114,20 +114,21 @@

ggtrace embodies an opinionated approach to learning/debugging/hacking ggplot2 internals. I recommend watching the following presentation(s) on ggtrace before getting started on any kind of code:

You can read the full philosophy behind ggtrace in the Getting Started vignette. But broadly speaking, ggtrace was designed with three goals in mind, in order of increasing complexity:

  1. -

    To help users understand the design of sublayer modularity, allowing them to write more expressive layer code using delayed aesthetic evaluation functions. This is a primarily pedagogical goal and outlined in my paper Sub-layer modularity in the Grammar of Graphics. The family of layer_*() extractor functions return snapshots of layer data in the internals, to help develop an accessible mental model of sublayer processes as a data wrangling pipeline.

    +

    To help users understand the design of sublayer modularity and write more expressive layer code using delayed aesthetic evaluation. This is a primarily pedagogical goal and outlined in my paper Sub-layer modularity in the Grammar of Graphics. The family of layer_*() extractor functions return snapshots of layer data in the internals, to help scaffold a mental model of sublayer processes as a data wrangling pipeline.

  2. To facilitate the user-developer transition, empowering experienced users of ggplot2 to start developing their own extension packages. This is achieved via a family of inspect, capture, and highjack workflow functions, which provide a functional interface into the object-oriented design of the internals (the <ggproto> OOP).

    3. -

  3. To provide a pseudo-extension mechanism for ggplot2, by injecting custom code to hack into the rendering pipeline. This is similar in spirit to {gggrid} and {gginnards}, but with a broader scope (targeting any arbitrary computation) at the cost of reproducibility (may break with even trivial changes to the ggplot2 codebase). This is achieved via the low-level function ggtrace() (extending the capabilities of base::trace()) and its functional form with_ggtrace(). See examples in the Overview vignette.

    4. +

  4. To provide a pseudo-extension mechanism for ggplot2, by injecting custom code that highjacks the rendering pipeline. This is similar in spirit to {gggrid} and {gginnards}, but with a broader scope (targeting any arbitrary computation) at some cost to reproducibility (may break with even trivial changes to the ggplot2 codebase). This is achieved via the low-level function ggtrace() (which improves upon base::trace()) and its functional form with_ggtrace(). See examples in the Overview vignette.

@@ -135,8 +136,9 @@

Example usage 

library(ggplot2)
-packageVersion("ggplot2")
-#> [1] '3.4.2'
+#> Warning: package 'ggplot2' was built under R version 4.3.1 +packageVersion("ggplot2") +#> [1] '3.4.3'

1) Inspect sub-layer data