merge conflicts and validate v1.46 baseline changes

Author: cpsievert

NAMESPACE

@@ -269,6 +269,7 @@ importFrom(tools,file_ext)
 importFrom(tools,file_path_sans_ext)
 importFrom(utils,browseURL)
 importFrom(utils,data)
+importFrom(utils,file.edit)
 importFrom(utils,getFromNamespace)
 importFrom(utils,modifyList)
 importFrom(utils,packageVersion)

NEWS.md

@@ -2,28 +2,29 @@
 
 ## Changes to plotly.js
 
-* This version of the R package upgrades the version of the underlying plotly.js library from v1.42.3 to v1.46.0. The [plotly.js release page](https://github.com/plotly/plotly.js/releases) has the full list of changes, but here is summary most pertainent ones for the R package:
+* This version of the R package upgrades the version of the underlying plotly.js library from v1.42.3 to v1.46.1. The [plotly.js release page](https://github.com/plotly/plotly.js/releases) has the full list of changes, but here is summary most pertainent ones for the R package:
   * New trace types: `sunburst`, `waterfall`, `isosurface`.
   * New `hovertemplate` attribute allows for finer-tuned control over tooltip text. See [here](https://plotly-r.com/controlling-tooltips.html#fig:tooltip-format-heatmap) for an example.
   * Providing a string to `title` is now deprecated (but still works). Instead, use `title = list(text = "title")`. This change was made to support a new title placement API (e.g., `title = list(text = "title", xanchor = "left")`). Note that these changes are relevant for `layout.title` as well as `layout.xaxis.title`/`layout.yaxis.title`/etc.
 
-## NEW FEATURES
+## NEW FEATURES & IMPROVEMENTS
 
-* The `orca_serve()` function was added for efficient exporting of many plotly graphs. For examples, see `help(orca_serve)`.
-* The `orca()` function gains new arguments `more_args` and `...` for finer control over the underlying system commands.
-* Improvements related to accessing plotly.js events in shiny:
-  * The `event` argument of the `event_data()` function now supports the following events: `plotly_selecting`, `plotly_brushed`, `plotly_brushing`, `plotly_restyle`, `plotly_legendclick`, `plotly_legenddoubleclick`, `plotly_clickannotation`, `plotly_afterplot`, `plotly_doubleclick`, `plotly_deselect`, `plotly_unhover`. For examples, see `plotly_example("shiny", "event_data")`, `plotly_example("shiny", "event_data_legends")`, and  `plotly_example("shiny", "event_data_annotation")`, 
+* Several new features and improvements related to accessing plotly.js events in shiny (learn more about them in this RStudio [webinar](https://resources.rstudio.com/webinars/accessing-and-responding-to-plotly-events-in-shiny-carson-sievert)):
+    * The `event` argument of the `event_data()` function now supports the following events: `plotly_selecting`, `plotly_brushed`, `plotly_brushing`, `plotly_restyle`, `plotly_legendclick`, `plotly_legenddoubleclick`, `plotly_clickannotation`, `plotly_afterplot`, `plotly_doubleclick`, `plotly_deselect`, `plotly_unhover`. For examples, see `plotly_example("shiny", "event_data")`, `plotly_example("shiny", "event_data_legends")`, and  `plotly_example("shiny", "event_data_annotation")`, 
     * New `event_register()` and `event_unregister()` functions for declaring which events to transmit over the wire (i.e., from the browser to the shiny server). Events that are likely to have large overhead are not registered by default, so you'll need to register these: `plotly_selecting`, `plotly_unhover`, `plotly_restyle`, `plotly_legendclick`, and `plotly_legenddoubleclick`.
-  * A new `priority` argument. By setting `priority='event'`, the `event` is treated like a true event: any reactive expression using the `event` becomes invalidated (regardless of whether the input values has changed). For an example, see `plotly_example("shiny", "event_priority")`.
-* The `method` argument of `plotlyProxyInvoke()` gains support for a `"reconfig"` method. This makes it possible to change just the configuration of a plot. For an example use, see `plotly_example("shiny", "event_data_annotation")`.
-
-## IMPROVEMENTS
-
-* The `orca()` function now supports conversion of much larger figures (#1322) and works without a mapbox api token (#1314).
-* The `style()` function now supports "partial updates" (i.e. modification of a particular property of an object, rather than the entire object). For example, notice how the first plot retains the original marker shape (a square): `p <- plot_ly(x = 1:10, y = 1:10, symbol = I(15)); subplot(style(p, marker.color = "red"), style(p, marker = list(color = "red")))` (#1342).
+    * A new `priority` argument. By setting `priority='event'`, the `event` is treated like a true event: any reactive expression using the `event` becomes invalidated (regardless of whether the input values has changed). For an example, see `plotly_example("shiny", "event_priority")`.
+    * The `event_data()` function now relays the (official plotly.js) `customdata` attribute in similar fashion to (unofficial) `key` attribute (#1423). Run `plotly_example("shiny", "event_data")` for an example. 
+    * `event_data("plotly_selected")` is no longer too eager to clear. That is, it is no longer set to `NULL` when clicking on a plot *after* triggering the "plotly_selected" event (#1121) (#1122).
+    
+* Several new features and improvements for exporting static graphs with the orca command-line utility:
+    * The `orca()` function now supports conversion of much larger figures (#1322) and works without a mapbox api token (#1314).
+    * The `orca_serve()` function was added for efficient exporting of many plotly graphs. For examples, see `help(orca_serve)`.
+    * The `orca()` function gains new arguments `more_args` and `...` for finer control over the underlying system commands.
+    
 * **plotly** objects can now be serialized and unserialized in different environments (i.e., you can now use `saveRDS()` to save an object as an rds file and restore it on another machine with `readRDS()`). Note this object is *dynamically* linked to JavaScript libraries, so one should take care to use consistent versions of **plotly** when serializing and unserializing (#1376).
-* The `plotly_example()` will now attempt to open the source file(s) used to run the example. Set `edit = FALSE` to prevent the source file(s) from opening.
-* The `event_data()` function now relays the (official plotly.js) `customdata` attribute in similar fashion to (unofficial) `key` attribute (#1423).
+* The `style()` function now supports "partial updates" (i.e. modification of a particular property of an object, rather than the entire object). For example, notice how the first plot retains the original marker shape (a square): `p <- plot_ly(x = 1:10, y = 1:10, symbol = I(15)); subplot(style(p, marker.color = "red"), style(p, marker = list(color = "red")))` (#1342).
+* The `method` argument of `plotlyProxyInvoke()` gains support for a `"reconfig"` method. This makes it possible to modify just the configuration of a plot in a **shiny** app. For an example use, see `plotly_example("shiny", "event_data_annotation")`.
+* The `plotly_example()` function will now attempt to open the source file(s) used to run the example. Set `edit = FALSE` to prevent the source file(s) from opening.
 * An informative warning is now thrown if invalid argument names are supplied to `config()`.
 
 ## CHANGES
@@ -36,9 +37,9 @@
 * `subplot()` now works much better with annotations, images, and shapes:
   - When `xref`/`yref` references an x/y axis these references are bumped accordingly (#1181).
   - When `xref`/`yref` references paper coordinates, these coordinates are updated accordingly (#1332).
-* `event_data("plotly_selected")` is no longer too eager to clear. That is, it is no longer set to `NULL` when clicking on a plot *after* triggering the "plotly_selected" event (#1121) (#1122).
 * The colorscale generated via the `color` argument in `plot_ly()` now uses an evenly spaced grid of values instead of quantiles (#1308).
 * When using **shinytest** to test a **shiny** that contains **plotly** graph, false positive differences are no longer reported (rstudio/shinytest#174). 
+* When the `size` argument maps to `marker.size`, it now converts to an array of appropriate length (#1479).
 * The `color` and `stroke` arguments now work as expected for trace types with `fillcolor` but no `fill` attribute (e.g. `box` traces) (#1292).
 * Information emitted by in `event_data()` for heatmaps with atomic vectors for `x`/`y`/`z` is now correct (#1141).
 * Fixed issue where **dplyr** groups caused a problem in the ordering of data arrays passed to `marker` objects (#1351).
@@ -47,6 +48,7 @@
 * Clearing a highlight event via crosstalk no longer deletes all the traces added since initial draw (#1436).
 * Recursive attribute validation is now only performed on recursive objects (#1315).
 * The `text` attribute is no longer collapsed to a string when `hoveron='fills+points'` (#1448). 
+* `layout.[x-y]axis.domain` is no longer supplied a default when `layout.grid` is specified (#1427).
 
 # 4.8.0
 

R/ggplotly.R

@@ -236,10 +236,18 @@ gg2list <- function(p, width = NULL, height = NULL,
     out
   }
 
+  # ggplot2 3.1.0.9000 introduced a Layer method named setup_layer() 
+  # currently, LayerSf is the only core-ggplot2 Layer that makes use
+  # of it https://github.com/tidyverse/ggplot2/pull/2875
+  data <- layer_data
+  if (packageVersion("ggplot2") > "3.1.0") {
+    data <- by_layer(function(l, d) l$setup_layer(d, plot))
+  }
+  
   # Initialise panels, add extra data for margins & missing facetting
   # variables, and add on a PANEL variable to data
   layout <- ggfun("create_layout")(plot$facet, plot$coordinates)
-  data <- layout$setup(layer_data, plot$data, plot$plot_env)
+  data <- layout$setup(data, plot$data, plot$plot_env)
 
   # save the domain of the group for display in tooltips
   groupDomains <- Map(function(x, y) {

R/imports.R

@@ -1,7 +1,7 @@
 #' @import ggplot2
 #' @importFrom grDevices col2rgb extendrange dev.list dev.off rgb as.raster
 #' @importFrom graphics layout
-#' @importFrom utils getFromNamespace modifyList data packageVersion browseURL str
+#' @importFrom utils getFromNamespace modifyList data packageVersion browseURL str file.edit
 #' @importFrom stats setNames complete.cases quantile is.leaf
 #' @importFrom tidyr unnest
 #' @importFrom viridisLite viridis

R/layers2traces.R

@@ -1000,7 +1000,12 @@ aes2plotly <- function(data, params, aes = "size") {
     type <- if (any(grepl("point", class(data)))) "point" else if (any(grepl("line", class(data)))) "line" else ""
     ggfun("default_aesthetics")(type)
   } else {
-    ggfun(geom)$default_aes
+    geom_obj <- ggfun(geom)
+    # If the first class of `data` is a data.frame,
+    # ggfun() returns a function because ggplot2 now
+    # defines data.frame in it's namespace
+    # https://github.com/ropensci/plotly/pull/1481
+    if ("default_aes" %in% names(geom_obj)) geom_obj$default_aes else NULL
   }
 
   vals <- uniq(data[[aes]]) %||% params[[aes]] %||% defaults[[aes]] %||% NA

R/plotly.R

@@ -444,7 +444,7 @@ typedArrayPolyfill <- function() {
 plotlyMainBundle <- function() {
   htmltools::htmlDependency(
     name = "plotly-main", 
-    version = "1.46.0",
+    version = "1.46.1",
     package = "plotly",
     src = dependency_dir("plotlyjs"),
     script = "plotly-latest.min.js",

R/plotly_build.R

@@ -377,6 +377,9 @@ plotly_build.plotly <- function(p, registerFrames = TRUE) {
 
   p <- verify_guides(p)
 
+  # verify colorscale attributes are in a sensible data structure
+  p <- verify_colorscale(p)
+  
   # verify plot attributes are legal according to the plotly.js spec
   p <- verify_attr_names(p)
   # box up 'data_array' attributes where appropriate
@@ -808,11 +811,6 @@ map_color <- function(traces, stroke = FALSE, title = "", colorway, na.color = "
         colorObj[c("cmin", "cmax")] <- NULL
         colorObj[["showscale"]] <- default(TRUE)
         traces[[i]] <- modify_list(colorObj, traces[[i]])
-        traces[[i]]$colorscale <- as_df(traces[[i]]$colorscale)
-        # sigh, contour colorscale doesn't support alpha
-        if (grepl("contour", traces[[i]][["type"]])) {
-          traces[[i]]$colorscale[, 2] <- strip_alpha(traces[[i]]$colorscale[, 2])
-        }
         traces[[i]] <- structure(traces[[i]], class = c("plotly_colorbar", "zcolor"))
         next
       }
@@ -856,8 +854,6 @@ map_color <- function(traces, stroke = FALSE, title = "", colorway, na.color = "
           traces[[i]] <- modify_list(list(fillcolor = col), traces[[i]])
         }
 
-        # make sure the colorscale is going to convert to JSON nicely
-        traces[[i]]$marker$colorscale <- as_df(traces[[i]]$marker$colorscale)
       }
     }
 

R/shiny.R

@@ -65,7 +65,7 @@ prepareWidget <- function(x) {
 }
 
 register_plot_events <- function(p) {
-  session <- getDefaultReactiveDomain()
+  session <- shiny::getDefaultReactiveDomain()
   eventIDs <- paste(p$x$shinyEvents, p$x$source, sep = "-")
   session$userData$plotlyShinyEventIDs <- unique(c(
     session$userData$plotlyShinyEventIDs,
@@ -153,7 +153,13 @@ event_data <- function(
     parseJSONVal(session$rootScope()$input[[eventID]])
   }
 
-  priority <- match.arg(priority)
+  # events that don't emit any data should _always_ be treated with event priority
+  priority <- if (event %in% c("plotly_doubleclick", "plotly_deselect", "plotly_afterplot")) {
+    "event"
+  } else {
+    match.arg(priority)
+  }
+  
   if (priority == "event") {
     # Shiny.setInputValue() is always called with event priority
     # so simply return the parse input value
@@ -181,6 +187,7 @@ event_data <- function(
 #' Register a shiny input value 
 #' 
 #' @inheritParams event_data
+#' @param p a plotly object.
 #' @seealso [event_data]
 #' @export
 #' @author Carson Sievert
@@ -192,6 +199,7 @@ event_register <- function(p, event = NULL) {
 #' Un-register a shiny input value
 #' 
 #' @inheritParams event_data
+#' @param p a plotly object.
 #' @seealso [event_data]
 #' @export
 #' @author Carson Sievert

R/utils.R

@@ -131,15 +131,6 @@ colorway <- function(p = NULL) {
 # TODO: make this more unique?
 crosstalk_key <- function() ".crossTalkKey"
 
-# modifyList turns elements that are data.frames into lists
-# which changes the behavior of toJSON
-as_df <- function(x) {
-  if (is.null(x) || is.matrix(x)) return(x)
-  if (is.list(x) && !is.data.frame(x)) {
-    setNames(as.data.frame(x), NULL)
-  }
-}
-
 # arrange data if the vars exist, don't throw error if they don't
 arrange_safe <- function(data, vars) {
   vars <- vars[vars %in% names(data)]
@@ -349,7 +340,7 @@ supply_defaults <- function(p) {
     p$x$layout[[p$x$layout$mapType]] <- modify_list(
       list(domain = geoDomain), p$x$layout[[p$x$layout$mapType]]
     )
-  } else {
+  } else if (!length(p$x$layout[["grid"]])) {
     types <- vapply(p$x$data, function(tr) tr[["type"]] %||% "scatter", character(1))
     axes <- unlist(lapply(types, function(x) {
       grep("^[a-z]axis$", names(Schema$traces[[x]]$attributes), value = TRUE) %||% NULL
@@ -503,12 +494,22 @@ verify_attr <- function(proposed, schema) {
       proposed$name <- uniq(proposed$name)
     }
 
-    # if marker.sizemode='area', make sure marker.size is boxed up 
-    # (otherwise, when marker.size is a constant, it always sets the diameter!)
+    # if marker.size was populated via `size` arg (i.e., internal map_size()), 
+    # then it should _always_ be an array
+    # of appropriate length...
+    # (when marker.size is a constant, it always sets the diameter!)
     # https://codepen.io/cpsievert/pen/zazXgw
     # https://github.com/plotly/plotly.js/issues/2735
-    if ("area" %in% proposed$marker$sizemode) {
-      proposed$marker[["size"]] <- i(proposed$marker[["size"]])
+    if (is.default(proposed$marker$size)) {
+      s <- proposed$marker[["size"]]
+      if (length(s) == 1) {
+        # marker.size could be of length 1, but we may have multiple 
+        # markers -- in that case, if marker.size is an array 
+        # of length 1 will result in just one marker
+        # https://codepen.io/cpsievert/pen/aMmOza
+        n <- length(proposed[["x"]] %||% proposed[["y"]] %||% proposed[["lat"]] %||% proposed[["lon"]])
+        proposed$marker[["size"]] <- default(i(rep(s, n)))
+      }
     }
 
     # do the same for "sub-attributes"
@@ -658,6 +659,51 @@ verify_mode <- function(p) {
   p
 }
 
+
+verify_colorscale <- function(p) {
+  p$x$data <- lapply(p$x$data, function(trace) {
+    trace$colorscale <- colorscale_json(trace$colorscale)
+    trace$marker$colorscale <- colorscale_json(trace$marker$colorscale)
+    trace
+  }) 
+  p
+}
+
+# Coerce `x` into a data structure that can map to a colorscale attribute.
+# Note that colorscales can either be the name of a scale (e.g., 'Rainbow') or 
+# a 2D array (e.g., [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']])
+colorscale_json <- function(x) {
+  if (!length(x)) return(x)
+  if (is.character(x)) return(x)
+  if (is.matrix(x)) {
+    if (ncol(x) != 2) stop("A colorscale matrix requires two columns")
+    x <- as.data.frame(x)
+    x[, 1] <- as.numeric(x[, 1])
+  }
+  # ensure a list like this: list(list(0, 0.5, 1), list("red", "white", "blue"))
+  # converts to the correct dimensions: [[0, 'red'], [0.5, 'white'], [1, 'blue']]
+  if (is.list(x) && length(x) == 2) {
+    n1 <- length(x[[1]])
+    n2 <- length(x[[2]])
+    if (n1 != n2 || n1 == 0 || n2 == 0) {
+      warning("A colorscale list must of elements of the same (non-zero) length")
+    } else if (!is.data.frame(x) && can_be_numeric(x[[1]])) {
+      x <- data.frame(
+        val = as.numeric(x[[1]]),
+        col = as.character(x[[2]]),
+        stringsAsFactors = FALSE
+      )
+      x <- setNames(x, NULL)
+    }
+  }
+  x
+}
+
+can_be_numeric <- function(x) {
+  xnum <- suppressWarnings(as.numeric(x))
+  sum(is.na(x)) == sum(is.na(xnum))
+}
+
 # if an object (e.g. trace.marker) contains a non-default attribute, it has been user-specified
 user_specified <- function(obj = NULL) {
   if (!length(obj)) return(FALSE)

inst/docker/Dockerfile.vtest

@@ -9,12 +9,13 @@ MAINTAINER Carson Sievert "[email protected]"
 
 # Don't print "debconf: unable to initialize frontend: Dialog" messages
 ARG DEBIAN_FRONTED=noninteractive
+ARG CACHEBUST=1
 
 # Need this to add R repo
 RUN apt-get update && apt-get install -y software-properties-common
 
 # Add R apt repository
-RUN add-apt-repository "deb http://cran.r-project.org/bin/linux/ubuntu $(lsb_release -cs)/"
+RUN add-apt-repository "deb http://cran.r-project.org/bin/linux/ubuntu $(lsb_release -cs)-cran35/"
 RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0x51716619e084dab9
 
 # Install basic stuff and R