Merge pull request #1278 from ropensci/name

make name a special argument

Author: cpsievert

NEWS.md

@@ -27,6 +27,7 @@
 
 ### `plot_ly()` specific changes
 
+* The `name` attribute is now a "special `plot_ly()` argument" and behaves similar to `split` (it ensures a different trace for every unique value supplied). Although this leads to a breaking change (`name` was previously appended to an automatically generated trace name), it leads to a more flexible and transparent API. Those that wish to have the old behavior back should provide relevant mappings to the `name` attributes (e.g. `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = "a")` should become `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = ~paste(vs, "\na"))`)
 * The `color` argument now maps to `fillcolor`, making it much easier to use polygon fills to encode data values (e.g., choropleth maps). For backwards-compatibilty reasons, when `color` maps to `fillcolor`, `alpha` defaults to 0.5 (instead of 1). For an example, `plot_mapbox(mn_res, color = ~INDRESNAME)` or `plot_mapbox(mn_res, split = ~INDRESNAME, color = ~AREA, showlegend = FALSE, stroke = I("black"))`.
 * The `color` argument no longer automatically add `"markers"` to the `mode` attribute for scatter/scattergl trace types. Those who wish to have the old behavior back, should add `"markers"` to the `mode` explicity (e.g., change `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines")` to `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines+markers")`).
 * The `size` argument now informs a default [error_[x/y].width](https://plot.ly/r/reference/#scatter-error_x-width) (and `span` informs [error_[x/y].thickness](https://plot.ly/r/reference/#scatter-error_x-thickness)). Note you can override the default by specifying directly (e.g. `plot_ly(x = 1:10, y = 1:10, size = I(10), error_x = list(value = 5, width = 0))`).

R/plotly.R

@@ -23,6 +23,9 @@
 #' (e.g. `plot_ly(x = 1:10, y = 1:10, color = I("red"), marker = list(color = "blue"))`).
 #' @param type A character string specifying the trace type (e.g. `"scatter"`, `"bar"`, `"box"`, etc).
 #' If specified, it *always* creates a trace, otherwise 
+#' @param name Values mapped to the trace's name attribute. Since a trace can 
+#' only have one name, this argument acts very much like `split` in that it 
+#' creates one trace for every unique value.
 #' @param color Values mapped to relevant 'fill-color' attribute(s) 
 #' (e.g. [fillcolor](https://plot.ly/r/reference#scatter-fillcolor), 
 #' [marker.color](https://plot.ly/r/reference#scatter-marker-color), 
@@ -124,7 +127,7 @@
 #' 
 #' }
 #' 
-plot_ly <- function(data = data.frame(), ..., type = NULL, 
+plot_ly <- function(data = data.frame(), ..., type = NULL, name,
                     color, colors = NULL, alpha = NULL, 
                     stroke, strokes = NULL, alpha_stroke = 1,
                     size, sizes = c(10, 100), 
@@ -160,6 +163,7 @@ plot_ly <- function(data = data.frame(), ..., type = NULL,
   }
 
   # tack on variable mappings
+  attrs$name <- if (!missing(name)) name
   attrs$color <- if (!missing(color)) color
   attrs$stroke <- if (!missing(stroke)) stroke
   attrs$size <- if (!missing(size)) size
@@ -193,10 +197,10 @@ plot_ly <- function(data = data.frame(), ..., type = NULL,
     # we always deal with a _list_ of traces and _list_ of layouts 
     # since they can each have different data
     layout = list(
-        width = width, 
-        height = height,
-        # sane margin defaults (mainly for RStudio)
-        margin = list(b = 40, l = 60, t = 25, r = 10)
+      width = width, 
+      height = height,
+      # sane margin defaults (mainly for RStudio)
+      margin = list(b = 40, l = 60, t = 25, r = 10)
     ),
     source = source
   )

R/plotly_build.R

@@ -189,7 +189,7 @@ plotly_build.plotly <- function(p, registerFrames = TRUE) {
       dataArrayAttrs, special_attrs(trace), npscales(), "frame",
       # for some reason, text isn't listed as a data array in some traces
       # I'm looking at you scattergeo...
-      ".plotlyGroupIndex", "text", "key", "fillcolor"
+      ".plotlyGroupIndex", "text", "key", "fillcolor", "name"
     )
     tr <- trace[names(trace) %in% allAttrs]
     # TODO: does it make sense to "train" matrices/2D-tables (e.g. z)?
@@ -205,7 +205,7 @@ plotly_build.plotly <- function(p, registerFrames = TRUE) {
       isAsIs <- vapply(builtData, function(x) inherits(x, "AsIs"), logical(1))
       isDiscrete <- vapply(builtData, is.discrete, logical(1))
       # note: can only have one linetype per trace
-      isSplit <- names(builtData) %in% c("split", "linetype", "frame", "fillcolor") |
+      isSplit <- names(builtData) %in% c("split", "linetype", "frame", "fillcolor", "name") |
         !isAsIs & isDiscrete & names(builtData) %in% c("symbol", "color")
       if (any(isSplit)) {
         paste2 <- function(x, y) if (identical(x, y)) x else paste(x, y, sep = br())
@@ -980,7 +980,7 @@ traceify <- function(dat, x = NULL) {
   new_dat <- list()
   for (j in seq_along(lvls)) {
     new_dat[[j]] <- lapply(dat, function(y) recurse(y, n, x %in% lvls[j]))
-    new_dat[[j]]$name <- lvls[j]
+    new_dat[[j]]$name <- new_dat[[j]]$name %||% lvls[j]
   }
   return(new_dat)
 }

R/utils.R

@@ -492,6 +492,10 @@ verify_attr <- function(proposed, schema) {
       proposed[[attr]] <- structure(proposed[[attr]], apiSrc = TRUE)
     }
 
+    if (length(proposed$name) > 0) {
+      proposed$name <- uniq(proposed$name)
+    }
+    
     # do the same for "sub-attributes"
     if (identical(role, "object")) {
       proposed[[attr]] <- verify_attr(proposed[[attr]], schema[[attr]])

tests/testthat/test-animate-highlight.R

@@ -373,15 +373,16 @@ test_that("animation button can be customized", {
 test_that("sf works with crosstalk", {
   skip_if_not_installed("sf")
 
-  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"))
+  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"), quiet = TRUE)
   # shared data will make the polygons "query-able"
-  ncsd <- SharedData$new(nc)
+  ncsd <- crosstalk::SharedData$new(nc)
   p <- ggplot(ncsd) +
     geom_sf(aes(fill = AREA, text = paste0(NAME, "\n", "FIPS: ", FIPS))) +
     ggthemes::theme_map()
   gg <- ggplotly(p, tooltip = "text")
   d <- gg$x$data
   for (i in seq_along(d)) {
+    if (!isTRUE(d[["_isGraticule"]])) next
     expect_false(is.null(d[[i]]$key))
     expect_false(is.null(d[[i]]$set))
   }

tests/testthat/test-plotly-name.R

@@ -0,0 +1,50 @@
+context("name-mapping")
+
+test_that("can create multiple traces from name argument", {
+  l <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, name = rep(c("a", "b"), 5)) %>%
+    plotly_build()
+  
+  expect_length(l$x$data, 2)
+  expect_equal(l$x$data[[1]]$name, "a")
+  expect_equal(l$x$data[[2]]$name, "b")
+})
+
+
+test_that("can override name argument", {
+  l <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, split = rep(c("a", "b"), 5), name = "z") %>%
+    plotly_build()
+
+  expect_length(l$x$data, 2)
+  expect_equal(l$x$data[[1]]$name, "z")
+  expect_equal(l$x$data[[2]]$name, "z")
+  
+  # can get back old behvaior
+  l2 <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, split = rep(c("a", "b"), 5), name = paste0(rep(c("a", "b"), 5), "<br>z")) %>%
+    plotly_build()
+  
+  expect_length(l2$x$data, 2)
+  expect_equal(l2$x$data[[1]]$name, "a<br>z")
+  expect_equal(l2$x$data[[2]]$name, "b<br>z")
+  
+})
+
+
+test_that("doesn't break old behavior", {
+  # from https://community.plot.ly/t/manual-color-bug/10479
+  density1 <- density(diamonds[diamonds$cut %in% "Fair", ]$carat)
+  density2 <- density(diamonds[diamonds$cut %in% "Ideal",]$carat)
+  
+  l <- plot_ly(x = ~density1$x, y = ~density1$y, type = 'scatter', mode = 'lines', name = 'Fair cut', fill = 'tozeroy',
+          fillcolor = 'rgba(168, 216, 234, 0.5)',
+          line = list(width = 0.5)) %>%
+    add_trace(x = ~density2$x, y = ~density2$y, name = 'Ideal cut', fill = 'tozeroy',
+              fillcolor = 'rgba(255, 212, 96, 0.5)') %>%
+    plotly_build()
+  
+  
+  expect_equal(l$x$data[[1]]$name, "Fair cut")
+  expect_equal(l$x$data[[2]]$name, "Ideal cut")
+})