Merge pull request #226 from ropensci/carson-dsl

Version 1.0

Author: cpsievert

.Rbuildignore

@@ -3,5 +3,8 @@ Karthik_local.R
 Makefile
 man-roxygen
 man-roxygen/^.*\.Rproj$
+^.*\.Rproj$
 ^\.Rproj\.user$
-vignettes/margins.sty
+^data-raw$
+vignettes/margins.sty
+CONDUCT.md

.travis.yml

@@ -1,18 +1,35 @@
-language: r
+language: c
 
-env:
-  global:
-    - secure: "cJ1bDRrAdIRjG+JnsQI9CdA4wQJhJJ2DdCNQ3frl8dotk69z61EiGCFW1Ir1cAY5V/NbHvFHp91HDiSo28ggwqRkEPBOGE44ico5gtVaELu3M/EnkWc2ZwQoN1273Vfdm26QYidqrvWrpLZ0XkFl7Q8xgvBswx30MF7y61+0Hv4="
+before_install:
+  - curl -OL http://raw.github.com/craigcitro/r-travis/master/scripts/travis-tool.sh
+  - chmod 755 ./travis-tool.sh
+  - ./travis-tool.sh bootstrap
+  # password is encrypted below
+  - echo "Sys.setenv('plotly_username' = 'dfvd')" > ~/.Rprofile
 
-r_packages:
-  - RCurl
-  - RJSONIO
-  - lattice
-  - xtable
-  - httr 
+install:
+  - ./travis-tool.sh install_deps
 
 before_script:
-  - chmod 755 inst/testscripts/.push_test_table.sh
+  - git config --global user.name "cpsievert"
+  - git config --global user.email "[email protected]"
+  - git clone https://github.com/cpsievert/plotly-test-table.git ../plotly-test-table
+
+script:
+  - Rscript -e "devtools::install(); source('tests/testthat.R', chdir = TRUE)"
 
 after_success:
-  - inst/testscripts/.push_test_table.sh
+  - cd ../plotly-test-table
+  - ls -R
+  - Rscript ../plotly/inst/build-push-comment.R
+
+env:
+  global:
+    # plotly_api_key (for posting to plot.ly)
+    - secure: "eHO4OUmgLusU9i4xSvr3daZxnsMZw3x4FH8BYVEC8Ja+Ey6kkAFFSh2iAC/CqewEYJ7I/M8aIJYqlyTMGRYUgy36WU7iWHAGgaZOU8fIB5dWzMwHbIvS4Naq2sdU7lRT7sxkS+40K1+rplpWDoLF2yt8vSRWo9rjNzp+yc8PjXM="
+    # GITHUB_PAT (for pushing to plotly-test-table)
+    - secure: "LHJONgWOo+98vNeFLI7LSJU3RtbMVszlI79GB8CcXmc2mlgM/UtZ5b6RnkNlhmg3Gj1/uObfm/rIybVTwuS1yNpeKv73+gsZOYhobVXiUGVxdRFG/mg5mbqwyWkkuofjPGFlMZCEMgHim37eZzgjSibwVH1LClRDsCoFMCgvgV0="
+    # plotlyjs_full (link to the full offline bundle)
+    - secure: "ivxfqGwbzpBpVJe+jVcOBktcmLrT38W/ZapAk/FNDu+yaBhag1eCYErAPPx6Snc4GzwatMt22v4SxAqXQF4SAhTRtmrWVaWnbhzuNqpTkiS6IKEd6EqaoyUZvUTgXh1ruyik00zl3ET9898O3vFfqafodljE0lCLVICHq6ANo68="
+    # plotlyjs_no_jq (link to the offline bundle w/o jQuery)
+    - secure: "i5cYEs2lCFSYgrSTHMmzzs8hRwAwiz89GpgM16fqUDQz8T1QMWofNugQInS7fIfKL36FoTz8BaiLs2D98/2kDkkZ0LTHnfrdrY9PO+7D+CmL8QeLLp4atBT0i682nwy8RzEqlvB8yAVQo/i0Eh8tmT97pppddsxttZKoUidfOeA=" 

CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http:contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

DESCRIPTION

@@ -1,38 +1,43 @@
 Package: plotly
-Type: Package
-Title: Interactive, publication-quality graphs online.
-Version: 0.6.3
-Authors@R: c(person("Chris", "Parmer", role = c("aut", "cre"),
+Title: Create interactive web-based graphs via plotly's API
+Version: 1.0.0
+Authors@R: c(person("Chris", "Parmer", role = c("aut", "cph"),
     email = "[email protected]"),
     person("Scott", "Chamberlain", role = "aut",
     email = "[email protected]"),
     person("Karthik", "Ram", role = "aut",
     email = "[email protected]"),
-    person("Toby", "Hocking", role="aut",
-    email="[email protected]"),
-    person("Marianne", "Corvellec", role="aut",
-    email="[email protected]"),
-    person("Pedro", "Despouy", role="aut",
-    email="[email protected]"),
-    person("Carson", "Sievert", role="aut",
-    email="[email protected]"))
-Author: Chris Parmer
-Maintainer: Marianne Corvellec <[email protected]>
+    person("Toby", "Hocking", role = "aut",
+    email = "[email protected]"),
+    person("Marianne", "Corvellec", role = "aut",
+    email = "[email protected]"),
+    person("Pedro", "Despouy", role = "aut",
+    email = "[email protected]"),
+    person("Carson", "Sievert", role = c("aut", "cre"),
+    email = "[email protected]"))
 License: MIT + file LICENSE
-Description: An interface to plotly's online graphing tools with desktop R
-    environments. Send data to a plotly account and view the graphs in a web
-    browser. Style the graphs with code or with plotly's online interface;
-    share data and graphs publicly with a url or privately among other plotly
-    members; access your graphs from anywhere. Example graph:
-    https://plot.ly/~chris/1638/
+Description: Create interactive web-based graphs via plotly's API.
+    Easily translate ggplot2 plots to plotly and/or create custom plotly graphs. 
+    Once uploaded to a plotly account, plotly graphs (and the data behind them) 
+    can be viewed and modified in a web browser.
 URL: https://github.com/ropensci/plotly
 BugReports: https://github.com/ropensci/plotly/issues
 Depends:
-    RCurl,
-    RJSONIO,
     ggplot2
 Imports:
-    knitr
+    scales,
+    httr,
+    jsonlite,
+    magrittr,
+    digest,
+    viridis
 Suggests:
+    dplyr,
     maps,
-    testthat
+    testthat,
+    knitr,
+    devtools,
+    shiny,
+    rmarkdown,
+    RColorBrewer
+LazyData: true

NAMESPACE

@@ -1,18 +1,34 @@
 # Generated by roxygen2 (4.1.1): do not edit by hand
 
+S3method(print,offline)
+S3method(print,plotly)
+export("%>%")
+export(add_trace)
+export(embed_notebook)
+export(get_figure)
 export(gg2list)
 export(ggplot_build2)
+export(ggplotly)
 export(group2NA)
+export(knit_print.offline)
+export(knit_print.plotly)
+export(last_plot)
 export(layer2traces)
+export(layout)
+export(offline)
 export(paramORdefault)
+export(plot_ly)
 export(plotly)
-export(set_config_file)
-export(set_credentials_file)
-export(show_config_file)
-export(show_credentials_file)
+export(plotlyOutput)
+export(plotly_POST)
+export(plotly_build)
+export(plotly_empty)
+export(renderPlotly)
 export(signup)
+export(style)
+export(subplot)
 export(toRGB)
-import(RCurl)
-import(RJSONIO)
 import(ggplot2)
-import(knitr)
+import(httr)
+import(jsonlite)
+importFrom(magrittr,"%>%")

NEWS

@@ -1,3 +1,17 @@
+1.0.0 -- 31 July 2015
+
+A major reworking of package internals which includes a few backwards incompatible changes. 
+
+Major changes include:
+
+(1) New high-level grammar for expressing Plotly graphs from R (see the `plot_ly()`, `add_trace()`, `layout()`, and `style()` functions).
+(2) New print methods which make it easier to create, modify, and embed Plotly graphs.
+(3) Added a `subplot()` function for putting several graphs on a single page.
+(4) Added the `renderPlotly()` and `plotlyOutput()` functions for embedding plotly graphs in shiny applications.
+(5) Added `offline()` function for creating standalone HTML pages via Plotly Offline (see http://purchasing.plot.ly/)
+
+For more details, see the new vignettes with `browseVignettes(package = "plotly")` and/or the pull request -> https://github.com/ropensci/plotly/pull/226
+
 0.6.3 -- 2 June 2015
 
 Add new tests inspired by the R Cookbook distributions #214

R/data.R

@@ -0,0 +1,23 @@
+#' Wind data
+#'
+#' Description TBD.
+#'
+#' @format A data frame with three variables: \code{r}, \code{t},
+#'   \code{nms}.
+"wind"
+
+#' Mic data
+#'
+#' Description TBD.
+#'
+#' @format A data frame with three variables: \code{r}, \code{t},
+#'   \code{nms}.
+"mic"
+
+#' Hobbs data
+#'
+#' Description TBD.
+#'
+#' @format A data frame with three variables: \code{r}, \code{t},
+#'   \code{nms}.
+"hobbs"

R/figure.R

@@ -0,0 +1,24 @@
+#' Request a figure object
+#' 
+#' Figure objects work in the same way as plotly objects, but when printed,
+#' they overwrite the already existing plotly object 
+#' (instead of creating a new plotly).
+#' 
+#' @param username corresponding username for the figure.
+#' @param id of the Plotly figure.
+#' @export
+#' @references https://plot.ly/rest/
+#' @examples
+#' \dontrun{
+#'  # Anyone can obtain the information for a particular plot
+#'  fig <- get_figure("cpsievert", "559")
+#'  # If you have proper credentials, you can easily modify
+#'  layout(fig, title = paste("Modified on ", Sys.time()))
+#' }
+get_figure <- function(username, id) {
+  if (missing(username)) username <- verify("username")
+  if (missing(id)) stop("Please provide a figure id number")
+  base_url <- file.path(get_domain(), "apigetfile", username, id)
+  resp <- httr::GET(base_url, plotly_headers(), httr::config(ssl_verifypeer=FALSE))
+  process(struct(resp, "figure"))
+}

R/ggplotly.R

@@ -1,3 +1,37 @@
+#' Create plotly graphs using ggplot2 syntax
+#'
+#' See up-to-date documentation and examples at
+#' \url{https://plot.ly/ggplot2}
+#'
+#' @param p a ggplot object.
+#' @seealso \link{signup}, \link{plot_ly}
+#' @import httr jsonlite
+#' @export
+#' @author Carson Sievert
+#' @examples \dontrun{
+#' # simple example
+#' ggiris <- qplot(Petal.Width, Sepal.Length, data = iris, color = Species)
+#' ggplotly(ggiris)
+#' 
+#' # maps!!
+#' data(canada.cities, package = "maps")
+#' viz <- ggplot(canada.cities, aes(long, lat)) +
+#'   borders(regions = "canada", name = "borders") +
+#'   coord_equal() +
+#'   geom_point(aes(text = name, size = pop), colour = "red",
+#'                alpha = 1/2, name = "cities")
+#'  ggplotly(viz)
+#' }
+#' 
+ggplotly <- function(p = last_plot()) {
+  l <- gg2list(p)
+  hash_plot(p$data, l)
+}
+
+# ----------------------------------------------------------------------------
+# Objects accessed inside gg2list()
+# ----------------------------------------------------------------------------
+
 # calc. the epoch
 now <- Sys.time()
 the.epoch <- now - as.numeric(now)
@@ -907,8 +941,17 @@ gg2list <- function(p) {
     flipped.layout[["yaxis"]] <- x
   }
 
-  fig <- list(data=flipped.traces, layout=flipped.layout)
-  
-  fig
-  
+  l <- list(data = flipped.traces, layout = flipped.layout)
+  # When auto_unbox is T in jsonlite::toJSON() it doesn't unbox objects of 
+  # class AsIs. We use this in plotly::to_JSON() and tag special fields such as
+  # x/y/etc so that they don't get unboxed when they are of length 1.
+  # unfortunately, this conflicts when using I() in qplot. For example,
+  # qplot(1:10, 1:10, size = I(10))
+  un <- function(x) {
+    if (is.null(x)) return(NA)
+    if (is.list(x)) lapply(x, un) 
+    else if (inherits(x, "AsIs")) unclass(x) 
+    else x
+  }
+  lapply(l, un)
 }