Merge pull request #210 from ropensci/marianne-gg2list-figure

Let gg2list return a figure object

Author: mkcor

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: plotly
 Type: Package
 Title: Interactive, publication-quality graphs online.
-Version: 0.5.29
+Version: 0.5.30
 Authors@R: c(person("Chris", "Parmer", role = c("aut", "cre"),
     email = "[email protected]"),
     person("Scott", "Chamberlain", role = "aut",

NAMESPACE

@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.1.0): do not edit by hand
+# Generated by roxygen2 (4.1.1): do not edit by hand
 
 export(gg2list)
 export(ggplot_build2)

NEWS

@@ -1,3 +1,7 @@
+0.5.30 -- 4 May 2015
+
+Let gg2list() return a figure object.
+
 0.5.29 -- 16 April 2015
 
 geom_density() as filled area chart #202 

R/ggplotly.R

@@ -70,9 +70,9 @@ markUnique <- as.character(unique(unlist(markLegends)))
 #' Convert a ggplot to a list.
 #' @import ggplot2
 #' @param p ggplot2 plot.
-#' @return list representing a ggplot.
+#' @return figure object (list with names "data" and "layout").
 #' @export
-gg2list <- function(p){
+gg2list <- function(p) {
   if(length(p$layers) == 0) {
     stop("No layers in plot")
   }
@@ -886,7 +886,8 @@ gg2list <- function(p){
     flipped.layout[["yaxis"]] <- x
   }
 
-  flipped.traces$kwargs <- list(layout=flipped.layout)
+  fig <- list(data=flipped.traces, layout=flipped.layout)
+
+  fig
 
-  flipped.traces
 }

R/plotly-package.r

@@ -7,7 +7,7 @@
 #' \itemize{
 #'  \item Package: plotly
 #'  \item Type: Package
-#'  \item Version: 0.5.20
+#'  \item Version: 0.5.30
 #'  \item Date: 2014-03-07
 #'  \item License: MIT
 #' }

R/plotly.R

@@ -82,14 +82,14 @@ For more help, see https://plot.ly/R or contact <[email protected]>.")
 
   # public attributes/methods that the user has access to
   pub <- list(username=username, key=key, filename="from api", fileopt=NULL,
-              version="0.5.20")
+              version="0.5.30")
   priv <- list()
 
   pub$makecall <- function(args, kwargs, origin) {
     if (is.null(kwargs$filename))
       kwargs$filename <- pub$filename
     if (is.null(kwargs$fileopt))
-      kwargs$fileopt <- NULL
+      kwargs$fileopt <- pub$fileopt
     url <- paste(base_url, "/clientresp", sep="")
 
     respst <- postForm(url, platform="R", version=pub$version, 
@@ -139,11 +139,15 @@ For more help, see https://plot.ly/R or contact <[email protected]>.")
     if(!is.ggplot(gg)){
       stop("gg must be a ggplot")
     }
-    pargs <- gg2list(gg)
+    fig <- gg2list(gg)
     if (!"auto_open" %in% names(kwargs)) {
       kwargs <- c(kwargs, auto_open=TRUE)
     }
-    pargs$kwargs <- c(pargs$kwargs, kwargs)
+    
+    pargs <- fig$data
+    pargs$kwargs <- kwargs
+    pargs$kwargs$layout <- fig$layout
+    
     if (session == "interactive") {  # we are on the command line
       resp <- do.call(pub$plotly, pargs)
       if (pargs$kwargs$auto_open) {

man/ensure_file_exist.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{ensure_file_exist}
 \alias{ensure_file_exist}

man/get_config_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{get_config_file}
 \alias{get_config_file}

man/get_credentials_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{get_credentials_file}
 \alias{get_credentials_file}

man/gg2list.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/ggplotly.R
 \name{gg2list}
 \alias{gg2list}
@@ -10,7 +10,7 @@ gg2list(p)
 \item{p}{ggplot2 plot.}
 }
 \value{
-list representing a ggplot.
+figure object (list with names "data" and "layout").
 }
 \description{
 Convert a ggplot to a list.

man/ggplot_build2.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/build_function.R
 \name{ggplot_build2}
 \alias{ggplot_build2}

man/group2NA.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/trace_generation.R
 \name{group2NA}
 \alias{group2NA}

man/layer2traces.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/trace_generation.R
 \name{layer2traces}
 \alias{layer2traces}

man/paramORdefault.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/marker_conversion.R
 \name{paramORdefault}
 \alias{paramORdefault}

man/plotly-package.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/plotly-package.r
 \docType{package}
 \name{plotly-package}
@@ -15,7 +15,7 @@ An example of an interactive graph made from the R API: https://plot.ly/~chris/4
 \itemize{
  \item Package: plotly
  \item Type: Package
- \item Version: 0.5.20
+ \item Version: 0.5.30
  \item Date: 2014-03-07
  \item License: MIT
 }

man/plotly.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/plotly.R
 \name{plotly}
 \alias{plotly}

man/set_config_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{set_config_file}
 \alias{set_config_file}

man/set_credentials_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{set_credentials_file}
 \alias{set_credentials_file}

man/show_config_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{show_config_file}
 \alias{show_config_file}

man/show_credentials_file.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/tools.R
 \name{show_credentials_file}
 \alias{show_credentials_file}

man/signup.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/signup.R
 \name{signup}
 \alias{signup}

man/toFill.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/colour_conversion.R
 \name{toFill}
 \alias{toFill}

man/toRGB.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/colour_conversion.R
 \name{toRGB}
 \alias{toRGB}

tests/testthat/test-cookbook-axes.R

@@ -8,14 +8,13 @@ expect_traces <- function(gg, n.traces, name){
   stopifnot(is.numeric(n.traces))
   save_outputs(gg, paste0("cookbook-axes-", name))
   L <- gg2list(gg)
-  is.trace <- names(L) == ""
-  all.traces <- L[is.trace]
+  all.traces <- L$data
   no.data <- sapply(all.traces, function(tr) {
     is.null(tr[["x"]]) && is.null(tr[["y"]])
   })
   has.data <- all.traces[!no.data]
   expect_equal(length(has.data), n.traces)
-  list(traces=has.data, kwargs=L$kwargs)
+  list(traces=has.data, layout=L$layout)
 }
 
 # Reverse the order of a discrete-valued axis
@@ -44,13 +43,13 @@ test_that("ylim hides points", {
 bp.scale.hide <- bp + scale_y_continuous(limits=c(5, 7.5))
 test_that("scale_y(limits) hides points", {
   info <- expect_traces(bp.scale.hide, 3, "scale.hide")
-  expect_equal(info$kwargs$layout$yaxis$range, c(5, 7.5))
+  expect_equal(info$layout$yaxis$range, c(5, 7.5))
 })
 
 bp.coord <- bp + coord_cartesian(ylim=c(5, 7.5))
 test_that("Using coord_cartesian zooms into the area", {
   info <- expect_traces(bp.coord, 3, "coord-ylim")
-  expect_equal(info$kwargs$layout$yaxis$range, c(5, 7.5))
+  expect_equal(info$layout$yaxis$range, c(5, 7.5))
 })
 
 # Create some noisy exponentially-distributed data
@@ -148,7 +147,7 @@ bp.fonts <- bp +
 
 test_that("element_text face, colour, size, angle, vjust, size", {
   info <- expect_traces(bp.fonts, 3, "fonts")
-  x <- info$kwargs$layout$xaxis
+  x <- info$layout$xaxis
   xtitle <- x[["titlefont"]]
   xtick <- x[["tickfont"]]
   expect_identical(xtitle$color, toRGB("#990000"))

tests/testthat/test-ggplot-abline.R

@@ -12,15 +12,15 @@ test_that("Second trace be the a-b line", {
 
   L <- gg2list(gg)
 
-  expect_equal(length(L), 3)
-  expect_true(L[[2]]$x[1] <= 0)
-  expect_true(L[[2]]$x[2] >= 3.5)
-  expect_identical(L[[2]]$mode, "lines")
-  expect_identical(L[[2]]$line$shape, "linear")
-  expect_equal(L[[2]]$line$width, 8)
+  expect_equal(length(L$data), 2)
+  expect_true(L$data[[2]]$x[1] <= 0)
+  expect_true(L$data[[2]]$x[2] >= 3.5)
+  expect_identical(L$data[[2]]$mode, "lines")
+  expect_identical(L$data[[2]]$line$shape, "linear")
+  expect_equal(L$data[[2]]$line$width, 8)
 
-  expect_identical(L[[1]]$showlegend, FALSE)
-  expect_identical(L[[2]]$showlegend, FALSE)
+  expect_identical(L$data[[1]]$showlegend, FALSE)
+  expect_identical(L$data[[2]]$showlegend, FALSE)
 
   save_outputs(gg, "abline")
 })

tests/testthat/test-ggplot-area.R

@@ -7,11 +7,11 @@ ar <- ggplot(huron) + geom_area(aes(x=year, y=level))
 L <- gg2list(ar)
 
 test_that("sanity check for geom_area", {
-  expect_equal(length(L), 2)
-  expect_identical(L[[1]]$type, "scatter")
-  expect_equal(L[[1]]$x, c(huron$year[1], huron$year, tail(huron$year, n=1)))
-  expect_equal(L[[1]]$y, c(0, huron$level, 0))
-  expect_identical(L[[1]]$line$color, "transparent")
+  expect_equal(length(L$data), 1)
+  expect_identical(L$data[[1]]$type, "scatter")
+  expect_equal(L$data[[1]]$x, c(huron$year[1], huron$year, tail(huron$year, n=1)))
+  expect_equal(L$data[[1]]$y, c(0, huron$level, 0))
+  expect_identical(L$data[[1]]$line$color, "transparent")
 })
 
 save_outputs(ar, "area")
@@ -21,8 +21,8 @@ gg <- ggplot(huron) + geom_area(aes(x=year, y=level), alpha=0.4)
 L <- gg2list(gg)
 
 test_that("transparency alpha in geom_area is converted", {
-  expect_identical(L[[1]]$line$color, "transparent")
-  expect_identical(L[[1]]$fillcolor, "rgba(51,51,51,0.4)")
+  expect_identical(L$data[[1]]$line$color, "transparent")
+  expect_identical(L$data[[1]]$fillcolor, "rgba(51,51,51,0.4)")
 })
 
 save_outputs(gg, "area-fillcolor")