IRdisplay (version 1.1)

display: Create and use multiple available reprs

Description

Both functions create a mimebundle for multiple reprs. display proceeds to publish it using publish_mimebundle. prepare_mimebundle returns it (see Value for details)

Usage

display(
  obj,
  ...,
  mimetypes = getOption("jupyter.display_mimetypes"),
  error_handler = stop
)
prepare_mimebundle(
  obj,
  mimetypes = getOption("jupyter.display_mimetypes"),
  metadata = NULL,
  error_handler = stop
)

Arguments

obj

The object to create representations for

mimetypes

Mimetypes to create reprs for. The defaults are defined by the option jupyter.display_mimetypes. (see: IRdisplay-options)

error_handler

Function used when errors in individual reprs occur

metadata, ...

Metadata to attach to the result (can be expanded by additional metadata)

Value

prepare_mimebundle returns a list with items corresponding to the parameters of publish_mimebundle (data and metadata)

See Also

publish_mimebundle

Examples

# NOT RUN {
bundle <- prepare_mimebundle(diag(3))

# }
# NOT RUN {
## (Run inside of an IRkernel)
display(help(display))
# }
# NOT RUN {
# }