Use an interactive graph as a widget, a ggplot or a file

A bar chart race from ggrace(), or a graph built by ggcausal(), ggnma(), ggmeta(), ggfunnel(), ggleague(), ggkm(), ggswimmer(), ggnomogram(), ggchoropleth(), ggdiagnostic(), ggsensitivity(), ggmultiverse(), ggresponder(), cinema_league(), cinema_contribution(), cinema_clinical(), cinema_incoherence() or cinema_network() prints as an interactive widget. These functions give the other forms it can take. graph_widget() returns the 'htmlwidgets' object, for use in 'shiny' or to save with htmlwidgets::saveWidget(). graph_plot() returns the underlying ggplot, which draws as an ordinary static plot. graph_save() writes either form to a file chosen by its extension.

Usage

graph_widget(x, theme = c("auto", "light", "dark"))

graph_plot(x, theme = c("light", "dark"))

graph_save(x, file, res = 300, theme = NULL)

# S3 method for class 'ggx_graph'
knit_print(x, ...)

# S3 method for class 'ggrace'
knit_print(x, ...)

Arguments

x: A race from ggrace(), whose static copy is its last frame, or a graph from ggcausal(), ggnma(), ggmeta(), ggfunnel(), ggleague(), ggkm(), ggswimmer(), ggnomogram(), ggchoropleth(), ggdiagnostic(), ggsensitivity(), ggmultiverse(), ggresponder(), cinema_league(), cinema_contribution(), cinema_clinical(), cinema_incoherence() or cinema_network().
theme: For the widget, "auto" follows the page it sits on: a dark 'pkgdown' or 'bslib' page (data-bs-theme="dark"), a dark Quarto theme, a page marked data-theme="dark", or, for a widget saved as its own page, the viewer's system setting. "light" and "dark" fix it. For graph_plot() and a PNG from graph_save(), "light" or "dark" picks the colors of the static copy; a saved .html defaults to "auto" and a .png to "light".
file: Output path. .html writes the widget as a single file, which needs 'pandoc'; .png writes a static image with 'ragg'.
res: Resolution of a PNG in pixels per inch.
...: Passed to knitr::knit_print().

Value

graph_widget() returns an htmlwidget and graph_plot() a ggplot. graph_save() returns file, invisibly.

Details

The graph is laid out at a fixed size, so its boxes always fit their labels. The widget scales to the width of the page it sits in; a static copy should be drawn at x$width by x$height inches, which is what graph_save() does. The widget embeds a web copy of Lato, so it looks the same on machines without the font.

On a dark page the widget switches to a dark palette of its own: the background, text, lines and neutral fills take their dark counterparts, colors that carry meaning keep their hue, and the hover cards and panels follow. It also follows a page that switches theme while it is open.

Examples

dag <- ggcausal(cleft_dag$edges, cleft_dag$nodes)
w <- graph_widget(dag)
p <- graph_plot(dag)
# \donttest{
graph_save(dag, tempfile(fileext = ".png"))
# }