bump to 0.4.8

yjunechoe · Feb 7, 2022 · 3e673f7 · 3e673f7
1 parent 5f1b348
commit 3e673f7
Show file tree

Hide file tree

Showing 45 changed files with 384 additions and 66 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: ggtrace
 Type: Package
 Title: Programmatically debug ggproto methods with trace
-Version: 0.4.7
+Version: 0.4.8
 Authors@R: c(
       person(given = "June",
            family = "Choe",

diff --git a/NEWS.md b/NEWS.md
@@ -1,9 +1,16 @@
 # ggtrace (development version)
 
+# ggtrace 0.4.8
+
 ### New Features
 
 - Added `with_ggtrace()` for a functional interface to `ggtrace()`
-- Added `ggtrace_capture_(fn|env)` functions which returns a snapshot of the function/environment of the ggproto method at execution time
+- Added `ggtrace_capture_fn()` and `ggtrace_capture_env()`, which return a snapshot of the function/environment of the ggproto method at execution time
+- Added `ggtrace_inspect_return()` and `ggtrace_modify_return()` to grab and swap return values at method's execution
+
+### Miscellaneous
+
+- Added workflows section to docs/references
 
 # ggtrace 0.4.7
 

diff --git a/R/with_ggtrace.R b/R/with_ggtrace.R
@@ -1,4 +1,4 @@
-#' Isolate a ggtrace call for a single ggplot object
+#' Apply a ggtrace call to a single ggplot object
 #'
 #' `with_ggtrace()` provides a functional interface to `ggtrace()`. It takes a ggplot object
 #'  and parameters passed to `ggtrace()` and returns the immediate tracedump without side effects.

diff --git a/R/workflows-modify.R b/R/workflows-modify.R
@@ -6,7 +6,7 @@
 #' @param cond When the return value should be replaced
 #' @param draw Whether to draw the modified plot
 #'
-#' @return A gtable object
+#' @return A gtable object with class `<ggtrace_modified>`
 #' @export
 #'
 ggtrace_modify_return <- function(x, method, value, cond = TRUE, draw = TRUE) {

diff --git a/README.Rmd b/README.Rmd
@@ -24,7 +24,7 @@ knitr::opts_chunk$set(
 # **{ggtrace}**
 
 <!-- badges: start -->
-[![](https://img.shields.io/badge/devel%20version-0.4.7-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
+[![](https://img.shields.io/badge/devel%20version-0.4.8-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
 [![](https://img.shields.io/badge/lifecycle-stable-gogreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
 <!-- badges: end -->
 
@@ -63,7 +63,7 @@ remotes::install_github("yjunechoe/ggtrace")
 ```
 
 ```{r setup}
-library(ggtrace) # v0.4.7
+library(ggtrace) # v0.4.8
 ```
 
 ## **Example 1 - `compute_layer` method from `PositionJitter`**

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 <!-- badges: start -->
 
-[![](https://img.shields.io/badge/devel%20version-0.4.7-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
+[![](https://img.shields.io/badge/devel%20version-0.4.8-gogreen.svg)](https://github.com/yjunechoe/ggtrace)
 [![](https://img.shields.io/badge/lifecycle-stable-gogreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
 <!-- badges: end -->
 
@@ -46,7 +46,7 @@ You can install the development version from
     # install.packages("remotes")
     remotes::install_github("yjunechoe/ggtrace")
 
-    library(ggtrace) # v0.4.7
+    library(ggtrace) # v0.4.8
 
 ## **Example 1 - `compute_layer` method from `PositionJitter`**
 

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -37,17 +37,31 @@ reference:
 - title: Workflows
   desc: >
     These function takes a ggplot object and a ggproto method, tracing and triggering
-    the method immediately without relying on side-effects
+    the method immediately without relying on side-effects. Most of these workflow
+    functions wraps around the lower-level function `with_ggtrace()`, a functional
+    complement to `ggtrace()`
   contents:
   - with_ggtrace
 
+- subtitle: Inspect
+  desc: >
+    Inspect values from steps in the method's execution for examination
+  contents:
+  - ggtrace_inspect_return
+
 - subtitle: Capture
   desc: >
-    Return a snapshot of a ggproto method's execution
+    Capture a snapshot of a method's execution state for dynamic evaluation
   contents:
   - ggtrace_capture_fn
   - ggtrace_capture_env
 
+- subtitle: Modify
+  desc: >
+    Modify the method's behavior as it is executed and return the graphical output
+  contents:
+  - ggtrace_modify_return
+
 - title: One-offs
   desc: Convenient shortcuts to common workflows without side effects
   contents:

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
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -10,5 +10,5 @@ articles:
   showcase-aes_evaluation: showcase-aes_evaluation.html
   showcase-ggplot_build: showcase-ggplot_build.html
   technical-details: technical-details.html
-last_built: 2022-02-06T00:15Z
+last_built: 2022-02-07T13:55Z
 
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
diff --git a/docs/reference/Rplot002.png b/docs/reference/Rplot002.png