collaborate is no longer a supported option for config and should not be included in the examples (#2486)

* Fixing docs for config() to avoid deprecated example

* Adding unit test for deprecation warning

* Rebuilding docs for collaborated deprecation change

Author: wkumler

R/layout.R

@@ -105,8 +105,8 @@ rangeslider <- function(p, start = NULL, end = NULL, ...) {
 #' @export
 #' @examplesIf interactive() || !identical(.Platform$OS.type, "windows")
 #' 
-#' # remove the plotly logo and collaborate button from modebar
-#' config(plot_ly(), displaylogo = FALSE, collaborate = FALSE)
+#' # remove the plotly logo and 2D lasso option from modebar
+#' config(plot_ly(), displaylogo = FALSE, modeBarButtonsToRemove = list("lasso2d"))
 #' 
 #' # enable mathjax
 #' # see more examples at https://plotly.com/r/LaTeX/

man/config.Rd

@@ -303,6 +303,12 @@ test_that("Informative deprecation message for titlefont", {
   expect_warning(config(plot_ly(), cloud = TRUE), "cloud")
 })
 
+test_that("Informative deprecation message for collaborate", {
+  p <- plot_ly(x = 1:3, mode = "markers", type = "scatter")
+  expect_warning(config(p, collaborate=TRUE), regexp = "collaborate button")
+  expect_warning(config(p, collaborate=FALSE), regexp = "collaborate button")
+})
+
 test_that("Informative warning for invalid config attr", {
   p <- config(plot_ly(), foobar = TRUE)
   expect_warning(plotly_build(p), "foobar")