plotly_IMAGE() seems to work

Author: cpsievert

NAMESPACE

@@ -32,5 +32,6 @@ export(toRGB)
 import(ggplot2)
 import(httr)
 import(jsonlite)
+importFrom(base64enc,base64encode)
 importFrom(magrittr,"%>%")
 importFrom(viridis,viridis)

R/plotly_IMAGE.R

@@ -8,29 +8,35 @@
 #' @param height Image height in pixels
 #' @param format The desired image format 'png', 'jpeg', 'svg', 'pdf', 'eps', or 'webp'
 #' @param scale Both png and jpeg formats will be scaled beyond the specified width and height by this number.
-#' @param encoded A boolean flag for base64 encoding of bytes
+#' @param out_file A filename for writing the image to a file.
+#' @param ... arguments passed onto \code{httr::POST}
 #' @export
 #' @examples
 #' 
-#' plotly_IMAGE(plot_ly(x = 1:10))
+#' p <- plot_ly(x = 1:10)
 #' 
+#' Png <- plotly_IMAGE(p, out_file = "plotly-test-image.png")
+#' Jpeg <- plotly_IMAGE(p, format = "jpeg", out_file = "plotly-test-image.jpeg")
+#' Svg <- plotly_IMAGE(p, format = "svg",  out_file = "plotly-test-image.svg")
+#' Pdf <- plotly_IMAGE(p, format = "pdf",  out_file = "plotly-test-image.pdf")
 #' 
 
 plotly_IMAGE <- function(x, width = 1000, height = 500, format = "png", 
-                         scale = 4, encoded = FALSE) {
+                         scale = 4, out_file, ...) {
   x <- plotly_build(x)
 
   bod <- list(
-    figure = to_JSON(x[c("data", "layout")]),
+    figure = x[c("data", "layout")],
     width = width,
     height = height,
     format = format,
     scale = scale,
-    encoded = encoded
+    encoded = FALSE
   )
-  
-  base_url <- file.path(get_domain("v2"), "images")
-  resp <- httr::POST(base_url, plotly_headers("v2"), body = bod)
+  base_url <- paste0(get_domain("v2"), "images")
+  resp <- httr::POST(base_url, plotly_headers("v2"), body = to_JSON(bod), 
+                     if (!missing(out_file)) write_disk(out_file, overwrite = TRUE), 
+                     ...)
   con <- process(struct(resp, "image"))
-  
+  invisible(con)
 }

R/plotly_POST.R

@@ -41,7 +41,7 @@ plotly_POST <- function(x) {
   base_url <- file.path(get_domain(), "clientresp")
   resp <- httr::POST(base_url, body = bod)
   con <- process(struct(resp, "clientresp"))
-  msg <- switch(kwargs$fileopt,
+  msg <- switch(x$fileopt %||% "new",
                 new = "Success! Created a new plotly here -> ",
                 overwrite = "Success! Modified your plotly here -> ")
   message(msg, con$url)

R/process.R

@@ -17,8 +17,9 @@ process.clientresp <- function(resp) {
 
 process.image <- function(resp) {
   httr::stop_for_status(resp)
-  browser()
-  con <- from_JSON(httr::content(resp, as = "text"))
+  # httr (should) know to call png::readPNG() which returns raster array
+  tryCatch(httr::content(resp, as = "parsed"), 
+           error = function(e) httr::content(resp, as = "raw"))
 }
 
 process.figure <- function(resp) {

R/utils.R

@@ -158,17 +158,20 @@ get_kwargs <- function() {
 plotly_headers <- function(type = "main") {
   usr <- verify("username")
   key <- verify("api_key")
+  v <- as.character(packageVersion("plotly"))
   h <- if (type == "v2") {
+    auth <- base64enc::base64encode(charToRaw(paste(usr, key, sep = ":")))
     c(
-      "plotly-username" = base64enc::base64encode(charToRaw(usr)),
-      "plotly-apikey" = base64enc::base64encode(charToRaw(key)),
-      "Plotly-Client-Platform" = paste("R", as.character(packageVersion("plotly")))
+      "authorization" = paste("Basic", auth),
+      "plotly-client-platform" = paste("R", v),
+      "plotly_version" = v,
+      "content-type" = "application/json"
     )
   } else {
     c(
       "plotly-username" = usr,
       "plotly-apikey" = key,
-      "plotly-version" = as.character(packageVersion("plotly")),
+      "plotly-version" = v,
       "plotly-platform" = "R"
     )
   }

man/plotly_IMAGE.Rd

@@ -5,7 +5,7 @@
 \title{Create/Modify plotly images}
 \usage{
 plotly_IMAGE(x, width = 1000, height = 500, format = "png", scale = 4,
-  encoded = FALSE)
+  out_file, ...)
 }
 \arguments{
 \item{x}{either a plotly object or a list.}
@@ -18,13 +18,21 @@ plotly_IMAGE(x, width = 1000, height = 500, format = "png", scale = 4,
 
 \item{scale}{Both png and jpeg formats will be scaled beyond the specified width and height by this number.}
 
-\item{encoded}{A boolean flag for base64 encoding of bytes}
+\item{out_file}{A filename for writing the image to a file.}
+
+\item{...}{arguments passed onto \code{httr::POST}}
 }
 \description{
 The images endpoint turn a plot (which may be given in multiple forms)
 into an image of the desired format.
 }
 \examples{
-plotly_IMAGE(qplot(1:10))
+p <- plot_ly(x = 1:10)
+
+# returns raster array representing the image
+img <- plotly_IMAGE(p, out_file = "plotly-test-image.png", overwrite = TRUE)
+
+img <- plotly_IMAGE(p, format = "pdf",
+  out_file = "plotly-test-image.pdf")
 }