Prepare an R Object for Being Displayed

A generic function that prepares R objects for display using display()

display_data(x, ...)

# S3 method for default
display_data(
  x,
  ...,
  data,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for htmlwidget
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for recordedplot
display_data(
  x,
  width = getOption("jupyter.plot.width", 6),
  height = getOption("jupyter.plot.height", 6),
  pointsize = getOption("jupyter.plot.pointsize", 12),
  resolution = getOption("jupyter.plot.res", 150),
  scale = getOption("jupyter.plot.scale", 0.5),
  units = getOption("jupyter.plot.units", "in"),
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE,
  ...
)

# S3 method for display_data
display_data(x, ...)

# S3 method for update_display_data
display_data(x, ...)

# S3 method for display_data
update(object, ...)

# S3 method for help_files_with_topic
display_data(x, ..., id = UUIDgenerate(), update = FALSE)

# S3 method for hsearch
display_data(x, ..., id = UUIDgenerate(), update = FALSE)

# S3 method for data.frame
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for matrix
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for html_elem
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for shiny.tag
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = UUIDgenerate(),
  update = FALSE
)

# S3 method for iframe
display_data(
  x,
  ...,
  metadata = emptyNamedList,
  id = attr(x, "id"),
  update = FALSE
)

# S3 method for Widget
display_data(x, ..., metadata = emptyNamedList, id = uuid(), update = FALSE)

Arguments

x

An object

...

Optional arguments tagged by mime types with mime data

data

A list with named elements, containing mime data

metadata

A list with named elements, containing metadata

id

An identifier string

update

A logical value, whether a new display item should be created or an existing one should be updated

width

Width of the diplayed plot

height

Height of the displayed plot

pointsize

Point size, see png

resolution

Resolution in ppi, see png

scale

The amount by which the plots are scaled in the frontend

units

Units of width and height, see png

object

An object of class "display_data"

Value

An object of class "display_data"

Methods (by class)

• display_data(default): Default method

• display_data(htmlwidget): S3 method for html widgets

• display_data(recordedplot): S3 method for plots saved with 'recordPlot()'

• display_data(display_data): S3 method for "display_data" objects

• display_data(update_display_data): S3 method for "update_display_data" objects

• display_data(help_files_with_topic): S3 method for help pages

• display_data(hsearch): S3 method for results of 'help.search()'

• display_data(data.frame): S3 method for class 'data.frame'

• display_data(matrix): S3 method for matrices

• display_data(html_elem): S3 method for "html_elem" objects (see html)

• display_data(shiny.tag): S3 methods for shiny objects

• display_data(iframe): S3 methods for "iframe" objects

• display_data(Widget): Method for jupyter widgets

Methods (by generic)

• update(display_data): "update" method for "display_data" objects