merge conflicts

Author: cpsievert

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: plotly
 Title: Create Interactive Web Graphics via 'plotly.js'
-Version: 4.4.5
+Version: 4.5.2
 Authors@R: c(person("Carson", "Sievert", role = c("aut", "cre"),
     email = "[email protected]"),
     person("Chris", "Parmer", role = c("aut", "cph"),

NAMESPACE

@@ -76,7 +76,9 @@ export(add_histogram2d)
 export(add_histogram2dcontour)
 export(add_lines)
 export(add_markers)
+export(add_mesh)
 export(add_paths)
+export(add_pie)
 export(add_polygons)
 export(add_ribbons)
 export(add_scattergeo)
@@ -119,7 +121,9 @@ export(layout)
 export(mutate)
 export(mutate_)
 export(offline)
+export(plot_geo)
 export(plot_ly)
+export(plot_mapbox)
 export(plotly)
 export(plotlyOutput)
 export(plotly_IMAGE)

NEWS.md

@@ -1,3 +1,37 @@
+# 4.5.2 -- 23 September 2016
+
+## NEW FEATURES
+
+* The new argument, `split`, replaces the old functionality of the now deprecated `group` argument by creating one trace per value.
+
+## BUG FIXES
+
+* Passing plots to `subplot()` without a specified color (once again) match the coloring defaults supplied by plotly.js (see #724).
+
+# 4.5.1 -- 23 September 2016
+
+## NEW FEATURES
+
+* A tibble with a list-column of plotly objects can now be input directly into `subplot()`
+
+## BUG FIXES
+
+* The `colorbar()` function now works on colorbars generated via `z` mapping.
+
+# 4.5.0 -- 22 September 2016
+
+## NEW FEATURES
+
+* Added the `plot_mapbox()` and `plot_geo()` functions, which make it easier to work with the "scattermapbox", "scattergeo", and "choropleth" trace types. See the maps chapter of the plotly book for some examples -- <https://cpsievert.github.io/plotly_book/maps.html> 
+* `subplot()` now accepts, and correctly scales mapbox objects.
+* Added the `add_mesh3d()` and `add_pie()` functions as wrappers around the "mesh3d", and "pie" trace types.
+
+## CHANGES
+
+* The `add_scattergeo()` and `add_choropleth()` functions have been deprecated in favor of `plot_geo()`. 
+* The `add_area(...)` function changed it's meaning from `add_lines(..., fill = 'tozeroy')` to a wrapper around the area trace <https://plot.ly/r/reference/#area>. This is more consistent with the naming conventions already in place for other `add_()` functions.
+* `add_ribbons()` now shows points (instead of fill) on hover.
+
 # 4.4.5 -- 19 September 2016
 
 ## NEW FEATURES

R/add.R

@@ -21,15 +21,8 @@ add_data <- function(p, data = NULL) {
 
 #' Add trace(s) to a plotly visualization
 #' 
-#' @param p a plotly or ggplot object.
-#' @param ... These arguments are documented in the references section below.
-#' Note that acceptable arguments depend on the trace type.
-#' @param color Either a variable name or a vector to use for color mapping.
-#' @param symbol Either a variable name or a (discrete) vector to use for symbol encoding.
-#' @param size A variable name or numeric vector to encode the size of markers.
-#' @param linetype Either a variable name or a (discrete) vector to use for linetype encoding.
-#' @param data A data frame to associate with this trace (optional). If not 
-#' provided, arguments are evaluated using the data frame in \code{\link{plot_ly}()}.
+#' @inheritParams plot_ly
+#' @param p a plotly object
 #' @param inherit inherit attributes from \code{\link{plot_ly}()}?
 #' @param z a numeric matrix
 #' @param x the x variable.
@@ -59,20 +52,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)
@@ -251,36 +238,61 @@ add_ribbons <- function(p, x = NULL, ymin = NULL, ymax = NULL, ...,
   add_trace_classed(
     p, class = c("plotly_ribbon", "plotly_polygon"), 
     x = x, ymin = ymin, ymax = ymax, type = "scatter", mode = "lines",
-    fill = "toself",  ..., data = data, inherit = inherit
+    hoveron = "points", fill = "toself",  ..., data = data, inherit = inherit
   )
 }
 
-
 #' @inheritParams add_trace
 #' @rdname add_trace
+#' @param r For polar chart only. Sets the radial coordinates.
+#' @param t For polar chart only. Sets the radial coordinates.
 #' @export
 #' @examples 
-#' huron <- data.frame(year = 1875:1972, level = as.vector(LakeHuron))
-#' plot_ly(huron, x = ~year, ymax = ~level) %>% add_area()
-add_area <- function(p, x = NULL, ymax = NULL, ...,
+#' p <- plot_ly(plotly::wind, r = ~r, t = ~t) %>% add_area(color = ~nms)
+#' layout(p, radialaxis = list(ticksuffix = "%"), orientation = 270)
+add_area <- function(p, r = NULL, t = NULL, ...,
                      data = NULL, inherit = TRUE) {
-  
   if (inherit) {
-    x <- x %||% p$x$attrs[[1]][["x"]]
-    ymax <- ymax %||% p$x$attrs[[1]][["ymax"]]
+    r <- t %||% p$x$attrs[[1]][["r"]]
+    t <- t %||% p$x$attrs[[1]][["t"]]
   }
-  if (is.null(x) || is.null(ymax)) {
-    stop("Must supply `x`/`ymax` attributes", call. = FALSE)
+  if (is.null(r) || is.null(t)) {
+    stop("Must supply `r`/`t` attributes", call. = FALSE)
   }
   add_trace_classed(
-    p, class = c("plotly_area", "plotly_ribbon", "plotly_polygon"), 
-    x = x, ymax = ymax,
-    type = "scatter", fill = "toself", mode = "lines",  
+    p, class = "plotly_area", r = r, t = t, type = "area",
     ..., data = data, inherit = inherit
   )
 }
 
-
+#' @inheritParams add_trace
+#' @rdname add_trace
+#' @param values the value to associated with each slice of the pie.
+#' @param labels the labels (categories) corresponding to \code{values}.
+#' @export
+#' @examples 
+#' ds <- data.frame(
+#'   labels = c("A", "B", "C"),
+#'   values = c(10, 40, 60)
+#' )
+#' 
+#' plot_ly(ds, labels = ~labels, values = ~values) %>%
+#'   add_pie() %>%
+#'   layout(title = "Basic Pie Chart using Plotly")
+add_pie <- function(p, values = NULL, labels = NULL, ...,
+                     data = NULL, inherit = TRUE) {
+  if (inherit) {
+    values <- values %||% p$x$attrs[[1]][["values"]]
+    labels <- labels %||% p$x$attrs[[1]][["labels"]]
+  }
+  if (is.null(values)) {
+    stop("Must supply `values`", call. = FALSE)
+  }
+  add_trace_classed(
+    p, class = "plotly_pie", values = values, labels = labels, type = "pie",
+    ..., data = data, inherit = inherit
+  )
+}
 
 #' @inheritParams add_trace
 #' @rdname add_trace
@@ -464,19 +476,23 @@ add_surface <- function(p, z = NULL, ..., data = NULL, inherit = TRUE) {
   )
 }
 
-
 #' @inheritParams add_trace
 #' @rdname add_trace
-#' @param geo anchor this trace on which geo object?
 #' @export
 #' @examples 
-#' plot_ly() %>% add_scattergeo()
-add_scattergeo <- function(p, geo = NULL, ..., data = NULL, inherit = TRUE) {
+#' plot_ly(x = c(0, 0, 1), y = c(0, 1, 0), z = c(0, 0, 0)) %>% add_mesh()
+add_mesh <- function(p, x = NULL, y = NULL, z = NULL, ..., 
+                        data = NULL, inherit = TRUE) {
   if (inherit) {
-    geo <- geo %||% p$x$attrs[[1]][["geo"]] %||% "geo"
+    x <- x %||% p$x$attrs[[1]][["x"]]
+    y <- y %||% p$x$attrs[[1]][["y"]]
+    z <- z %||% p$x$attrs[[1]][["z"]]
+  }
+  if (is.null(x) || is.null(y) || is.null(z)) {
+    stop("Must supply `x`/`y`/`z` attributes", call. = FALSE)
   }
   add_trace_classed(
-    p, class = "plotly_scattergeo", type = "scattergeo", geo = geo, 
+    p, class = "plotly_mesh", x = x, y = y, z = z, type = "mesh3d", 
     ..., data = data, inherit = inherit
   )
 }
@@ -485,24 +501,18 @@ add_scattergeo <- function(p, geo = NULL, ..., data = NULL, inherit = TRUE) {
 #' @inheritParams add_trace
 #' @rdname add_trace
 #' @export
-#' @examples 
-#' density <- state.x77[, "Population"] / state.x77[, "Area"]
-#' plot_ly(z = ~density) %>% 
-#'   add_choropleth(locations = state.abb, locationmode = 'USA-states') %>%
-#'   layout(geo = list(scope = "usa"))
-add_choropleth <- function(p, z = NULL, geo = NULL, ..., 
+add_scattergeo <- function(p, ...) {
+  .Deprecated("geo")
+  p
+}
+
+#' @inheritParams add_trace
+#' @rdname add_trace
+#' @export
+add_choropleth <- function(p, z = NULL, ..., 
                            data = NULL, inherit = TRUE) {
-  if (inherit) {
-    z <- z %||% p$x$attrs[[1]][["z"]]
-    geo <- geo %||% p$x$attrs[[1]][["geo"]] %||% "geo"
-  }
-  if (is.null(z)) {
-    stop("Must supply `z` attribute", call. = FALSE)
-  }
-  add_trace_classed(
-    p, class = "plotly_choropleth", z = z, type = "choropleth", geo = geo,
-    ..., data = data, inherit = inherit
-  )
+  .Deprecated("geo")
+  p
 }
 
 # attach a class to a trace which informs data processing in plotly_build
@@ -515,12 +525,16 @@ add_trace_classed <- function(p, class = "plotly_polygon", ...) {
 
 # retrieve the non-plotly.js attributes for a given trace
 special_attrs <- function(trace) {
-  switch(
+  attrs <- switch(
     class(trace)[[1]],
-    plotly_area = c("ymax"),
     plotly_segment = c("xend", "yend"),
     plotly_ribbon = c("ymin", "ymax")
   )
+  # for data training, we temporarily rename lat/lon as x/y
+  if (isTRUE(trace[["type"]] %in% c("scattermapbox", "scattergeo"))) {
+    attrs <- c(attrs, c("x", "y"))
+  }
+  attrs
 }
 
 

R/coord.R

@@ -0,0 +1,66 @@
+#' *** This won't be possible until plotly.js implements aspect ratios... ***
+#' 
+#' #' Force the aspect ratio according to x and y scales
+#' #' 
+#' #' When x and y are numeric variables measured on the same scale,
+#' #' or are related in some meaningful way, forcing the aspect ratio of the
+#' #' plot to be proportional to the ratio of a unit change in x versus y improves
+#' #' our ability to correctly perceive the data.
+#' #' 
+#' #' @param p a plotly object
+#' #' @param ratio aspect ratio, expressed as y / x
+#' #' @export
+#' #' @examples 
+#' #' 
+#' #' canada <- map_data("world", "canada")
+#' #' 
+#' #' canada %>%
+#' #'   group_by(group) %>%
+#' #'   plot_ly(x = ~long, y = ~lat, alpha = 0.2) %>%
+#' #'   add_polygons(hoverinfo = "none", color = I("black")) %>%
+#' #'   coord_fix()
+#' #' 
+#' #' # works on (non-faceted) ggplot2 plots, too
+#' #' gg <- ggplot(canada, aes(long, lat, group = group)) + 
+#' #'   geom_polygon() + coord_fixed()
+#' #' 
+#' #' gg %>%
+#' #'   ggplotly() %>%
+#' #'   coord_fix()
+#' #'   
+#' 
+#' coord_fix <- function(p, ratio = 1) {
+#'   p <- plotly_build(p)
+#'   # this won't work for subplots, or categorical data
+#'   x <- grepl("^xaxis", names(p$x$layout))
+#'   y <- grepl("^yaxis", names(p$x$layout))
+#'   if (sum(x) > 1 || sum(y) > 1) {
+#'     stop("Can not impose aspect ratio a plot with more than one x/y axis", call. = FALSE)
+#'   }
+#'   xDat <- unlist(lapply(p$x$data, "[[", "x"))
+#'   yDat <- unlist(lapply(p$x$data, "[[", "y"))
+#'   if (!is.numeric(xDat) || !is.numeric(yDat)) {
+#'     stop("Must have numeric data on both x and y axes to enforce aspect ratios", call. = FALSE)
+#'   }
+#'   
+#'   # warn about any pre-populated domains, they will get squashed
+#'   xDom <- p$x$layout[["xaxis"]]$domain %||% c(0, 1)
+#'   yDom <- p$x$layout[["yaxis"]]$domain %||% c(0, 1)
+#'   if (!identical(yDom, c(0, 1)) || !identical(xDom, c(0, 1))) {
+#'     warning(
+#'       "coord_fix() won't respect prespecified axis domains (other than the default)",
+#'       call. = FALSE
+#'     )
+#'   }
+#'   
+#'   xRng <- range(xDat, na.rm = TRUE)
+#'   yRng <- range(yDat, na.rm = TRUE)
+#'   asp <- ratio * diff(yRng) / diff(xRng)
+#'   if (asp < 1) {
+#'     p$x$layout[["yaxis"]]$domain <- c(0 + asp / 2, 1 - asp / 2)
+#'   } else {
+#'     asp <- 1 / asp
+#'     p$x$layout[["xaxis"]]$domain <- c(0 + asp / 2, 1 - asp / 2)
+#'   }
+#'   p
+#' }

R/dev.R

@@ -12,7 +12,7 @@
 #' plotly_json(plot_ly())
 #' plotly_json(plot_ly(), FALSE)
 
-plotly_json <- function(p = plot_ly(), jsonedit = interactive(), ...) {
+plotly_json <- function(p = last_plot(), jsonedit = interactive(), ...) {
   plotlyJSON <- to_JSON(plotly_build(p)$x, pretty = TRUE)
   if (jsonedit) {
     if (system.file(package = "listviewer") == "") {

R/helpers.R

@@ -16,9 +16,16 @@ colorbar <- function(p, ...) {
   if (sum(isBar) != 1) {
     stop("This function only works with one colorbar")
   }
-  p$x$data[[which(isBar)]]$marker$colorbar <- modify_list(
-    p$x$data[[which(isBar)]]$marker$colorbar, list(...)
-  ) 
+  tr <- p$x$data[[which(isBar)]]
+  if (inherits(tr, "zcolor")) {
+    p$x$data[[which(isBar)]][["colorbar"]] <- modify_list(
+      tr[["colorbar"]], list(...)
+    )
+  } else {
+    p$x$data[[which(isBar)]]$marker$colorbar <- modify_list(
+      tr$marker$colorbar, list(...)
+    )
+  }
   p
 }