add argument to view source files in plotly_example(), relay ... to demo(), update news

cpsievert · cpsievert · commit 561871df8673 · 2018-12-06T17:25:51.000-06:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -71,6 +71,6 @@ Suggests:
     plotlyGeoAssets,
     forcats
 LazyData: true
-RoxygenNote: 6.1.0
+RoxygenNote: 6.1.1
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
diff --git a/NEWS.md b/NEWS.md
@@ -11,6 +11,7 @@
 * 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).
 * **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.
 
 ## BUG FIXES
 
diff --git a/R/plotly_example.R b/R/plotly_example.R
@@ -5,20 +5,21 @@
 #' 
 #' @param type the type of example
 #' @param name the name of the example (valid names depend on `type`).
+#' @param edit whether to open the relevant source files using [file.edit]. Only relevant if `type` is `"shiny"` or `"rmd"`.
 #' @param ... arguments passed onto the suitable method.
 #' @export
 #' @author Carson Sievert
 
-plotly_example <- function(type = c("demo", "shiny", "rmd"), name, ...) {
+plotly_example <- function(type = c("demo", "shiny", "rmd"), name, edit = TRUE, ...) {
   
   type <- match.arg(type)
   
   # demos don't necessarily need a name
   if (type == "demo") {
     if (missing(name)) {
-      return(utils::demo(package = "plotly")) 
+      return(utils::demo(package = "plotly", ...)) 
     } else  {
-      return(utils::demo(topic = name, package = "plotly"))
+      return(utils::demo(topic = name, package = "plotly", ...))
     }
   }
   
@@ -36,6 +37,11 @@ plotly_example <- function(type = c("demo", "shiny", "rmd"), name, ...) {
   }
   
   finalDir <- system.file("examples", type, name, package = "plotly")
+  if (edit) {
+    files <- list.files(finalDir, full.names = TRUE)
+    scripts <- files[tools::file_ext(files) %in% c("R", "Rmd")]
+    file.edit(scripts)
+  }
   
   if (type == "shiny") {
     try_library("shiny", "plotly_example")
diff --git a/man/plotly_example.Rd b/man/plotly_example.Rd
