IRkernel · flying-sheep · Apr 14, 2015 · Apr 2, 2015 · Apr 3, 2015 · Apr 3, 2015
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 *.ipynb_checkpoints
 .Rproj.user
+.RData
+.Rhistory
+*.pdf
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -21,3 +21,8 @@ Imports:
     jsonlite (>= 0.9.6),
     uuid,
     digest
+Collate:
+    'options.R'
+    'execution.r'
+    'help.r'
+    'kernel.r'
diff --git a/Demo.ipynb b/Demo.ipynb
diff --git a/Display.ipynb b/Display.ipynb
diff --git a/IRkernel.Rproj b/IRkernel.Rproj
@@ -0,0 +1,18 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 4
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace
diff --git a/NAMESPACE b/NAMESPACE
@@ -7,9 +7,12 @@ export(set_plot_options)
 import(digest)
 import(evaluate)
 import(methods)
+import(repr)
 import(rzmq)
 import(uuid)
 importFrom(IRdisplay,display)
+importFrom(IRdisplay,display_alternatives)
 importFrom(IRdisplay,display_png)
+importFrom(base64enc,base64encode)
 importFrom(jsonlite,fromJSON)
 importFrom(jsonlite,toJSON)
diff --git a/R/execution.r b/R/execution.r
@@ -1,28 +1,7 @@
-displayenv = environment(display)
-
-plot_options=new.env() # environment for storing plot-options
-
-#'Set options for plotting
-#'
-#'IRkernel displays plots in the notebook with calls to png().
-#'This function allows to set the variables that will be passed on to
-#'png(), for example width or height, see help(png).
-#' @param ... options that will be passed to  png()
-#' @export
-set_plot_options <- function(...){
-    options <- list(...)
-    for(opt in names(options)){
-        assign( opt, options[[opt]], plot_options )
-    }
-}
+#' @include options.R
+NULL
 
-#'Get options for plotting
-#'
-#'Use set_plot_options() for modifying.
-#' @export
-get_plot_options <- function(){
-    return(as.list(plot_options))
-}
+displayenv = environment(display)
 
 lappend <- function(lst, obj) {
     # I hope this isn't the best way to do this.
@@ -43,6 +22,11 @@ plot_builds_upon <- function(prev, current) {
     return((lcurrent >= lprev) && (identical(current[[1]][1:lprev], prev[[1]][1:lprev])))
 }
 
+# needed to easily encode reprs as json.
+setOldClass('repr')
+asJSON <- jsonlite:::asJSON
+setMethod('asJSON', 'repr', function(x, ...) jsonlite:::asJSON(structure(x, class = NULL, repr.format = NULL), ...))
+
 Executor = setRefClass("Executor",
             fields=c("execution_count", "payload", "err", "interrupted", "kernel",
                      "last_recorded_plot"),
@@ -83,12 +67,12 @@ execute = function(request) {
     payload <<- lappend(payload, list(source='page', text=paste(text, collapse="\n")))
   })
 
-  send_plot = function(plotobj) {
-      tf = tempfile(fileext='.png')
-      do.call(png, c(list(filename=tf), get_plot_options()))
-      replayPlot(plotobj)
-      dev.off()
-      display_png(file=tf)
+  send_plot <- function(plotobj) {
+      params <- list()
+      for (mime in getOption('jupyter.plot_mimetypes')) {
+          params[[mime]] <- mime2repr[[mime]](plotobj)
+      }
+      display(params)
   }
 
   err <<- list()

diff --git a/R/help.r b/R/help.r
@@ -1,17 +1,33 @@
-#'An R kernel for IPython.
+#' An R kernel for IPython.
+#' 
+#' IPython's modern interfaces, including the IPython Notebook, speak a JSON+ZMQ
+#' protocol to a 'kernel' which is responsible for executing code. This protocol
+#' is language agnostic, so other languages can take advantage of IPython's rich
+#' UI by implementing a kernel. This package is a kernel for the R language.
+#' 
+#' @section Options:
+#' 
+#' The following can be set/read via \code{options(opt.name = ...)} / \code{getOption('opt.name')}
+#' 
+#' \describe{
+#'   \item{\code{jupyter.plot_mimetypes}}{
+#'      The plot formats emitted to the frontend when a plot is displayed.
+#'      (default: image/png, application/pdf, and image/svg+xml)
+#'   }
+#' }
 #'
-#'IPython's modern interfaces, including the IPython Notebook, speak a JSON+ZMQ
-#'protocol to a 'kernel' which is responsible for executing code. This protocol
-#'is language agnostic, so other languages can take advantage of IPython's rich
-#'UI by implementing a kernel. This package is a kernel for the R language.
 #' @export main
+#' 
+#' @import repr
 #' @import methods
 #' @import rzmq
 #' @import uuid
 #' @import digest
 #' @import evaluate
 #' @importFrom jsonlite fromJSON toJSON
-#' @importFrom IRdisplay display display_png
+#' @importFrom base64enc base64encode
+#' @importFrom IRdisplay display display_png display_alternatives
+#' 
 #' @docType package
 #' @name IRkernel
 #' @aliases IRkernel IRkernel-package

diff --git a/R/options.R b/R/options.R
@@ -0,0 +1,28 @@
+#' @export
+set_plot_options <- function(...) {
+    .Deprecated('options', msg = 'use the `repr.plot.*` options from the repr package instead')
+    opts <- list(...)
+    names(opts) <- paste0('repr.plot.', names(opts))
+    do.call(options, opts)
+}
+
+#' @export
+get_plot_options <- function() {
+    .Deprecated('getOption', msg = 'use the `repr.plot.*` options from the repr package instead')
+    all.opts <- options()
+    plot.opt.idx <- grep('^repr.plot', names(all.opts))
+    plot.opts <- all.opts[plot.opt.idx]
+    names(plot.opts) <- gsub('^repr\\.plot\\.', '', names(plot.opts))
+    return(as.list(plot.opts))
+}
+
+# all plot mime types. default value for the jupyter.plot_mimetypes option
+plot_mimetypes <- c(
+    'image/png',
+    'application/pdf',
+    'image/svg+xml')
+
+.onLoad = function(libname = NULL, pkgname = NULL) {
+    if (is.null(getOption('jupyter.plot_mimetypes')))
+        options(jupyter.plot_mimetypes = plot_mimetypes)
+}
diff --git a/README.md b/README.md
@@ -55,8 +55,9 @@ you'll lose all your variables if it crashes.
       install.packages('RCurl')
       library(devtools)
       install_github('armstrtw/rzmq')
-      install_github("IRkernel/IRdisplay")
-      install_github("IRkernel/IRkernel")
+      install_github('IRkernel/repr')
+      install_github('IRkernel/IRdisplay')
+      install_github('IRkernel/IRkernel')
 
       # Only if you have IPython 3 or above installed:
       IRkernel::installspec()

diff --git a/man/IRkernel.Rd b/man/IRkernel.Rd
@@ -11,4 +11,16 @@ protocol to a 'kernel' which is responsible for executing code. This protocol
 is language agnostic, so other languages can take advantage of IPython's rich
 UI by implementing a kernel. This package is a kernel for the R language.
 }
+\section{Options}{
+
+
+The following can be set/read via \code{options(opt.name = ...)} / \code{getOption('opt.name')}
+
+\describe{
+  \item{\code{jupyter.plot_mimetypes}}{
+     The plot formats emitted to the frontend when a plot is displayed.
+     (default: image/png, application/pdf, and image/svg+xml)
+  }
+}
+}
 
diff --git a/man/get_plot_options.Rd b/man/get_plot_options.Rd
diff --git a/man/installspec.Rd b/man/installspec.Rd
@@ -4,7 +4,7 @@
 \alias{installspec}
 \title{Install the kernelspec to tell IPython (>= 3) about IRkernel}
 \usage{
-installspec(user = F)
+installspec(user = T)
 }
 \arguments{
 \item{user}{Install into user directory ~/.ipython or globally?}

diff --git a/man/set_plot_options.Rd b/man/set_plot_options.Rd