webshot2

DESCRIPTION

@@ -18,7 +18,7 @@ Imports:
     utils,
     htmlwidgets,
     rstudioapi,
-    webshot,
+    webshot2,
     styler,
     methods,
     here,
@@ -30,7 +30,8 @@ Suggests:
     rmarkdown,
     esquisse,
     tidyselect,
-    purrr
+    purrr,
+    webshot
 RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
 VignetteBuilder: knitr

R/03_0_flow_view.R

@@ -32,7 +32,7 @@
 #'   can also be a vector of block ids, in this case `browser()` calls will be
 #'   inserted at the start of these blocks
 #' @param out a path to save the diagram to.
-#'   Special values "html", "htm", "png", "pdf", "jpg" and "jpeg" can be used to
+#'   Special values "html", "htm", "png", "pdf", "jpg", "jpeg" and "webp" can be used to
 #'   export the object to a temp file of the relevant format and open it,
 #'   if a regular path is used the format will be guessed from the extension.
 #' @param engine either `"nomnoml"` (default) or `"plantuml"` (experimental, brittle

R/03_1_flow_view_nomnoml.R

@@ -37,7 +37,12 @@ print.flow_diagram <- function(x, ...) {
     png <- tempfile("flow_", fileext = ".png")
     html <- tempfile("flow_", fileext = ".html")
     do.call(htmlwidgets::saveWidget, c(list(widget, html, FALSE)))
-    webshot::webshot(html, png, selector = "canvas")
+    if (isFALSE(getOption("flow.webshot2"))) {
+      webshot::webshot(html, png, selector = "canvas")
+    } else {
+      webshot2::webshot(html, png, selector = "canvas")
+    }
+
     #FIXME: printing should return the input, but couldn't find another way here
     return(knitr::include_graphics(png))
   } else {
@@ -73,7 +78,7 @@ save_nomnoml <- function(code, out) {
   }
 
   ## flag if out is a temp file shorthand
-  is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg")
+  is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg", "webp")
 
   ## is it ?
   if (is_tmp) {
@@ -92,7 +97,11 @@ save_nomnoml <- function(code, out) {
     ## save to a temp html file then convert to required output
     html <- tempfile("flow_", fileext = ".html")
     do.call(htmlwidgets::saveWidget, c(list(widget, html)))
-    webshot::webshot(html, out, selector = "canvas")
+    if (isFALSE(getOption("flow.webshot2"))) {
+      webshot::webshot(html, out, selector = "canvas")
+    } else {
+      webshot2::webshot(html, out, selector = "canvas")
+    }
   }
 
   ## was the out argument a temp file shorthand ?

R/04_0_flow_run.R

@@ -102,7 +102,7 @@ flow_run <-
       # hence the following call
       nomnoml::nomnoml_validate()
 
-      is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg")
+      is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg", "webp")
       if (is_tmp) {
         out <- tempfile("flow_", fileext = paste0(".", out))
       }
@@ -113,7 +113,11 @@ flow_run <-
       } else {
         html <- tempfile("flow_", fileext = ".html")
         do.call(htmlwidgets::saveWidget, c(list(widget, html)))
-        webshot::webshot(html, out, selector = "canvas")
+        if (isFALSE(getOption("flow.webshot2"))) {
+          webshot::webshot(html, out, selector = "canvas")
+        } else {
+          webshot2::webshot(html, out, selector = "canvas")
+        }
       }
 
       if (is_tmp) {

R/07_C.R

@@ -166,7 +166,7 @@ build_plantuml_code_from_c <- function(x, fun = NULL, out = NULL) {
         }
 
         ## flag if out is a temp file shorthand
-        is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg")
+        is_tmp <- out %in% c("html", "htm", "png", "pdf", "jpg", "jpeg", "webp")
 
         ## is it ?
         if (is_tmp) {

R/12_flow_view_source_calls.R

@@ -12,11 +12,14 @@ extract_strings <- function(call) {
 #' This evaluates the `file` argument of `source` in the global environment,
 #' when this fails, as it might with constructs like `for (file in files) source(file)`
 #' the unevaluated argument is printed instead between backticks. Since this messes
-#' up the relationships in the graph, an warning is thus issued. In a case like `source(file.path(my_dir, "foo.R")`
+#' up the relationships in the graph, an warning is thus issued. In a case like `source(file.path(my_dir, "foo.R"))`
 #' defining `my_dir` will be enough to solve the issue.
 #' In the latter case, if `smart` is `TRUE`, the function will check in all the paths in scope
 #' if any script is named "foo.R" and will consider it if a single fitting candidate is found.
 #'
+#' `c(c(1)`
+#' `c(c(1))`
+#'
 #' @param paths Paths to scripts or folders containing scripts
 #'   By default explores the working directory.
 #' @param recursive Passed to `list.files()` when `paths` contains directories

R/flow-package.R

@@ -6,3 +6,16 @@
 ## usethis namespace: end
 NULL
 
+#' options for the 'flow' package
+#'
+#' * `flow.indenter`: To circumvent a limitation from nomnoml we use by default
+#' the Braille character `"\u2800"` in places where consecutive standard
+#' spaces would be ignored. On some systems it doesn't print nicely though,
+#' `"\u00b7"` is another option that looks nice.
+#' * `flow.svg`: Whether to use svg graphics in html or viewer output.
+#' * `flow.webshot2`: Whether to use 'webshot2', set to `FALSE` to use 'webshot'
+#' as was the default until version `0.2.0`.
+#'
+#' @aliases flow.indenter flow.svg flow.webshot2
+#' @name flow-options
+NULL

R/zz.R

@@ -18,7 +18,8 @@ NULL
   op <- options()
   op.flow <- list(
     flow.indenter = "\u2800",
-    flow.svg = TRUE
+    flow.svg = TRUE,
+    flow.webshot2 = TRUE
   )
   toset <- !(names(op.flow) %in% names(op))
   if(any(toset)) options(op.flow[toset])