better printing of figures

Author: cpsievert

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(print,figure)
 S3method(print,plotly)
 export("%>%")
 export(add_trace)
@@ -10,6 +11,7 @@ export(gg2list)
 export(ggplot_build2)
 export(ggplotly)
 export(group2NA)
+export(knit_print.figure)
 export(knit_print.plotly)
 export(last_plot)
 export(layer2traces)

R/plotly.R

@@ -381,10 +381,6 @@ plotly_build <- function(l = last_plot()) {
   kwargs <- Reduce(modifyList, c(kwargs, list(x[get_kwargs()])))
   # empty keyword arguments can cause problems
   kwargs <- kwargs[sapply(kwargs, length) > 0]
-  # filename & fileopt are keyword arguments required by the API
-  if (!is.null(x$url) || !is.null(kwargs$filename)) 
-    kwargs$fileopt <- "overwrite"
-  kwargs$fileopt <- kwargs$fileopt %||% "new"
   # try our damndest to assign a sensible filename
   if (is.null(kwargs$filename)) {
     kwargs$filename <- 

R/plotly_POST.R

@@ -52,5 +52,5 @@ plotly_POST <- function(x, filename, fileopt = "new", world_readable = TRUE) {
                 new = "Success! Created a new plotly here -> ",
                 overwrite = "Success! Modified your plotly here -> ")
   message(msg, con$url)
-  con
+  structure(con, class = "figure")
 }

R/print.R

@@ -47,19 +47,46 @@ toWidget <- function(x) {
   )
 }
 
-#' Embed a plotly iframe into a IPython Notebook
+#' Print a plotly figure object
+#' 
+#' @param x a plotly figure object
+#' @param ... additional arguments (currently ignored)
+#' @export
+print.figure <- function(x, ...) {
+  browseURL(x$url)
+}
+
+#' Embed a plotly figure as an iframe in a knitr doc
+#' 
+#' @param x a plotly figure object
+#' @param options knitr options.
+#' @param ... placeholder.
+#' @export
+#' @references https://github.com/yihui/knitr/blob/master/vignettes/knit_print.Rmd
+knit_print.figure <- function(x, options, ...) {
+  if (!requireNamespace("knitr")) {
+    warning("Please install.packages('knitr')")
+    return(x)
+  }
+  w <- if (is.null(options[["width"]])) "800" else options[["width"]]
+  h <- if (is.null(options[["height"]])) "600" else options[["height"]]
+  iframe <- plotly_iframe(x$url, w, h)
+  knitr::asis_output(iframe)
+}
+
+#' Embed a plotly figure as an iframe into a IPython Notebook
 #' @param x a plotly object
 #' @param width attribute of the iframe
 #' @param height attribute of the iframe
 #' @export
 embed_notebook <- function(x, width = "100%", height = "525") {
+  if (!"figure" %in% class(x)) stop("x must be a plotly figure")
   if (system.file(package = "IRdisplay") == "") {
     warning("You need the IRdisplay package to use this function: \n",
             "devtools::install_github(c('IRkernel/repr', 'IRKernel/IRdisplay'))")
     return(x)
   }
-  resp <- plotly_POST(x)
-  iframe <- plotly_iframe(attr(resp, "url"), width, height)
+  iframe <- plotly_iframe(x$url, width, height)
   get("display_html", envir = asNamespace("IRdisplay"))(iframe)
 }