Skip to contents

Display a Krona chart as HTML widget

Source: R/widget.R
plot_krona.Rd

Pre-generated HTML charts can be displayed given a character string or supplied with file = ..., or the chart can be directly generated with make_krona() and directly displayed.

Usage

plot_krona(
  x,
  ...,
  file = NULL,
  outfile = NULL,
  opts = NULL,
  display = NULL,
  interactive = NULL,
  width = NULL,
  height = NULL,
  elementId = NULL
)

Arguments

x

Character string with a pre-generated HTML chart, or a matrix, data frame, list or phyloseq object that serves as input for generating the chart with make_krona().

...

Additional arguments passed to make_krona

file

File path, URL or file connection pointing to an already generated chart (passed instead of x)

outfile

Write the embedded chart to file

display

A ChartDisplayOpts() instance configuring the (initial) appearance of embedded charts or snapshots.

interactive

If FALSE, a non-interactive HTML chart is shown, which does not have any buttons and does not allow selecting and zooming. This is primarily useful for taking snapshots of embedded widgets, and is automatically activated in plot_krona when rendering in static documents. If set to TRUE, charts embedded in static documents such as PDF and Word are unmodified snapshots with buttons and other controls. Note that outfile = ... still exports a "normal" interactive Krona chart (see snapshot option in ChartOpts for making the exported chart non-interactive).

width, height

Width/height of the widget. Must be a valid CSS unit (like '100%', '400px', 'auto') or a number, which will be coerced to a string and have 'px' appended.

Value

A HTML widget embedable in R-Markdown / Quarto documents. Optionally, outfile can be specified to also save the chart to a HTML file.

Details

When generating the widget, some settings are adjusted depending on the environment. In static (non-HTML) documents such as PDF or Word, a snapshot is taken, which hides the buttons, search box and other things (can be changed with interactive = TRUE). Still, some additional configuration might be required to ensure that the charts look nice in every context (see taxplore_configure_snapshot()).

See also

make_krona(), ChartOpts(), ChartDisplayOpts()