add new split argument to replace old group argument

Author: cpsievert

R/add.R

@@ -59,20 +59,14 @@ add_data <- function(p, data = NULL) {
 #'   add_markers(color = ~pop) %>%
 #'   layout(showlegend = FALSE)
 #' 
-add_trace <- function(p, ..., color, symbol, size, linetype, 
+add_trace <- function(p, ...,
                       data = NULL, inherit = TRUE) {
 
   # "native" plotly arguments
   attrs <- list(...)
 
-  # tack on "special" arguments
-  attrs$color <- if (!missing(color)) color
-  attrs$symbol <- if (!missing(symbol)) symbol
-  attrs$linetype <- if (!missing(linetype)) linetype
-  attrs$size <- if (!missing(size)) size
-  
   if (!is.null(attrs[["group"]])) {
-    warning("The group argument has been deprecated. Use group_by() instead.")
+    warning("The group argument has been deprecated. Use group_by() or split instead.")
   }
 
   p <- add_data(p, data)

R/plotly.R

@@ -31,6 +31,10 @@
 #' Either valid \link{par} (lty) or plotly dash codes may be supplied.
 #' @param size A variable name or numeric vector to encode the size of markers.
 #' @param sizes A numeric vector of length 2 used to scale sizes to pixels.
+#' @param split A formula containing a name or expression. Similar to
+#' \code{\link{group_by}()}, but ensures at least one trace for each unique
+#' value. This replaces the functionality of the (now deprecated)
+#' \code{group} argument.
 #' @param width	Width in pixels (optional, defaults to automatic sizing).
 #' @param height Height in pixels (optional, defaults to automatic sizing).
 #' @param source Only relevant for \link{event_data}.
@@ -84,7 +88,7 @@
 plot_ly <- function(data = data.frame(), ..., type = NULL, 
                     color, colors = NULL, alpha = 1, symbol, symbols = NULL, 
                     size, sizes = c(10, 100), linetype, linetypes = NULL,
-                    width = NULL, height = NULL, source = "A") {
+                    split, width = NULL, height = NULL, source = "A") {
   if (!is.data.frame(data)) {
     stop("First argument, `data`, must be a data frame.", call. = FALSE)
   }
@@ -99,7 +103,7 @@ plot_ly <- function(data = data.frame(), ..., type = NULL,
   }
   if (!is.null(attrs[["group"]])) {
     warning(
-      "The group argument has been deprecated. Use `group_by()` instead.\n",
+      "The group argument has been deprecated. Use `group_by()` or split instead.\n",
       "See `help('plotly_data')` for examples"
     )
     attrs[["group"]] <- NULL
@@ -114,6 +118,7 @@ plot_ly <- function(data = data.frame(), ..., type = NULL,
   attrs$symbol <- if (!missing(symbol)) symbol
   attrs$linetype <- if (!missing(linetype)) linetype
   attrs$size <- if (!missing(size)) size
+  attrs$split <- if (!missing(split)) split
 
   attrs$colors <- colors
   attrs$alpha <- alpha

R/plotly_build.R

@@ -163,7 +163,8 @@ plotly_build.plotly <- function(p) {
       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% "linetype" |
+      isSplit <- names(builtData) %in% "split"
+        names(builtData) %in% "linetype" |
         !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 />")

R/utils.R

@@ -49,7 +49,7 @@ getLevels <- function(x) {
 
 # currently implemented non-positional scales in plot_ly()
 npscales <- function() {
-  c("color", "symbol", "linetype", "size")
+  c("color", "symbol", "linetype", "size", "split")
 }
 
 # copied from https://github.com/plotly/plotly.js/blob/master/src/components/color/attributes.js