add geo argument to add_choropleth()

Author: cpsievert

R/add.R

@@ -490,15 +490,17 @@ add_scattergeo <- function(p, geo = NULL, ..., data = NULL, inherit = TRUE) {
 #' plot_ly(z = ~density) %>% 
 #'   add_choropleth(locations = state.abb, locationmode = 'USA-states') %>%
 #'   layout(geo = list(scope = "usa"))
-add_choropleth <- function(p, z = NULL, ..., data = NULL, inherit = TRUE) {
+add_choropleth <- function(p, z = NULL, geo = 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", 
+    p, class = "plotly_choropleth", z = z, type = "choropleth", geo = geo,
     ..., data = data, inherit = inherit
   )
 }

R/helpers.R

@@ -1,3 +1,28 @@
+#' Modify the colorbar
+#' 
+#' @param p a plotly object
+#' @param ... arguments are documented here 
+#' \url{https://plot.ly/r/reference/#scatter-marker-colorbar}.
+#' @author Carson Sievert
+#' @export
+#' @examples 
+#' 
+#' plot_ly(mpg, x = ~cty, y = ~hwy, color = ~cyl) %>%
+#'   colorbar(len = 0.5)
+#' 
+colorbar <- function(p, ...) {
+  p <- plotly_build(p)
+  isBar <- vapply(p$x$data, is.colorbar, logical(1))
+  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(...)
+  ) 
+  p
+}
+
+
 #' Hide guides (legends and colorbars)
 #'
 #' @param p a plotly object.

R/layout.R

@@ -32,7 +32,7 @@ layout.plotly <- function(p, ..., data = NULL) {
 
 #' Add a range slider to the x-axis
 #'
-#' @param a plotly object.
+#' @param p plotly object.
 #' @param ... these arguments are documented here 
 #' \url{https://plot.ly/r/reference/#layout-xaxis-rangeslider}
 #' @export