add ... argument to add_fun(); fix annotation accumulation logic; add test

Author: cpsievert

R/add.R

@@ -490,6 +490,7 @@ special_attrs <- function(trace) {
 #' @param p a plotly object.
 #' @param fun a function. Should take a plotly object as input and return a 
 #' modified plotly object.
+#' @param ... arguments passed to \code{fun}.
 #' @export
 #' @examples
 #' 
@@ -515,9 +516,9 @@ special_attrs <- function(trace) {
 #'       add_annotations(text = "Bad mileage")
 #'   })
 #'
-add_fun <- function(p, fun) {
+add_fun <- function(p, fun, ...) {
   oldDat <- p$x$cur_data
-  p <- fun(p)
+  p <- fun(p, ...)
   p$x$cur_data <- oldDat
   p$x$attrs[length(p$x$attrs)] <- setNames(
     list(p$x$attrs[[length(p$x$attrs)]]), oldDat
@@ -539,12 +540,12 @@ add_fun <- function(p, fun) {
 #' # single annotation
 #' plot_ly(mtcars, x = ~wt, y = ~mpg) %>%
 #'   slice(which.max(mpg)) %>%
-#'   annotation(text = "Good mileage")
+#'   add_annotations(text = "Good mileage")
 #'   
 #' # multiple annotations
 #' plot_ly(mtcars, x = ~wt, y = ~mpg) %>%
 #'   filter(gear == 5) %>%
-#'   annotation("five cylinder", ax = 40) 
+#'   add_annotations("five cylinder", ax = 40) 
 #'   
 
 add_annotations <- function(p, text = NULL, ..., data = NULL) {

R/plotly_build.R

@@ -55,11 +55,9 @@ plotly_build.plotly <- function(p) {
 
   # accumulate, rather than override, annotations.
   annotations <- Reduce(c, c(
-    if (is.null(names(p$x$layout$annotations))) p$x$layout$annotations else list(p$x$layout$annotations),
-    compact(lapply(layouts, "[", "annotations"))
+    list(p$x$layout$annotations),
+    setNames(compact(lapply(layouts, "[[", "annotations")), NULL)
   ))
-  # annotations shouldn't have names
-  annotations <- setNames(annotations[[1]], NULL)
 
   # merge layouts into a single layout (more recent layouts will override older ones)
   p$x$layout <- modify_list(p$x$layout, Reduce(modify_list, layouts))

man/add_annotations.Rd

@@ -19,3 +19,28 @@ test_that("plotly_data preserves groups in data", {
   expect_true(dplyr::groups(d)[[1]] == "vs")
 })
 
+test_that("add_fun can apply two different chunks of data to a plot", {
+  p <- plot_ly(mtcars, x = ~wt, y = ~mpg) %>%
+    add_markers() %>%
+    add_fun(function(p) {
+      p %>% slice(which.max(mpg)) %>% add_annotations("Good mileage")
+    }) %>%
+    add_fun(function(p) {
+      p %>% slice(which.min(mpg)) %>% add_annotations(text = "Bad mileage")
+    })
+  l <- plotly_build(p)[["x"]]
+  expect_equal(length(l$layout$annotations), 2)
+  expect_equal(
+    sort(sapply(l$layout$annotations, "[[", "text")),
+    c("Bad mileage", "Good mileage")
+  )
+  expect_equal(
+    sort(sapply(l$layout$annotations, "[[", "x")),
+    c(1.835, 5.250)
+  )
+  expect_equal(
+    sort(sapply(l$layout$annotations, "[[", "y")),
+    c(10.4, 33.9)
+  )
+})
+