[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#947379: RFP: r-cran-irdisplay -- An interface to the rich display capabilities of Jupyter front-ends. Designed to be used from a running IRkernel.



Package: wnpp
Severity: wishlist

* Package name    : r-cran-irdisplay
  Version         : 0.7.0
  Upstream Author : Thomas Kluyver
* URL             : https://cran.r-project.org/package=IRdisplay
* License         : MIT
  Programming Lang: R
  Description     : An interface to the rich display capabilities of 'Jupyter' front-ends. Designed to be used from a running IRkernel.


IRdisplay is a front-end package for Jupyter. It’s automatically integrated into IRkernel when you open a Jupyter notebook using that kernel.

The primary, high level functions are:

display(obj, ..., mimetypes=<from option>, error_handler=stop)

display_png(data = NULL, file = NULL, width = NULL, height = NULL)
# display_jpeg(…); display_pdf(…); display_svg(…)

display_html(data = NULL, file = NULL)
# display_javascript(…), display_json(…), display_markdown(…), display_latex(…)

Use display to display an object in all configured mime types (see Configuration), and the display_* functions to display raw data you have in form of a file or a variable.

Manual use is possible via the *_mimebundle functions:

prepare_mimebundle(obj, mimetypes=<from option>, metadata=NULL, error_handler=stop)
publish_mimebundle(data, metadata = NULL)

Where prepare_mimebundle uses repr to create a mimebundle containing representations of objects, and publish_mimebundle sends such mimebundles to Jupyter.

Reply to: