Skip to contents

Sunburst chart object

Source: R/ms_sunburstchart.R
ms_sunburstchart.Rd

Creation of a sunburst chart object that can be inserted in a 'Microsoft' document. Sunburst charts use the chartEx pipeline (Office 2016+); older versions of 'Microsoft Office' will display a fallback placeholder.

Data is hierarchical: one column per level (parent to leaf, left to right) and one numeric column for the leaf values. Leaf values propagate to parent rings as sums.

Usage

ms_sunburstchart(data, path, value, labels = NULL)

Arguments

data

a data.frame.

path

character vector of column names defining the hierarchy, from outermost (root) to innermost (leaf).

value

column name for the numeric leaf values.

labels

unused for now; reserved for future custom data label columns.

Value

An ms_chart object (subclass ms_sunburstchart).

Per-leaf coloring

Same caveat as ms_treemapchart(): per-leaf colors via chart_data_fill() only work reliably with length(path) == 1.

See also

chart_labels(), ms_treemapchart()

Other 'Office' chart objects: ms_areachart(), ms_barchart(), ms_boxplotchart(), ms_bubblechart(), ms_chart_combine(), ms_funnelchart(), ms_histogramchart(), ms_linechart(), ms_paretochart(), ms_piechart(), ms_radarchart(), ms_scatterchart(), ms_stockchart(), ms_treemapchart(), ms_waterfallchart()

Examples

library(officer)

dat <- data.frame(
  region  = c("EU", "EU", "EU", "AM", "AM"),
  country = c("FR", "FR", "DE", "US", "US"),
  city    = c("Paris", "Lyon", "Berlin", "NYC", "LA"),
  value   = c(10, 5, 12, 20, 8),
  stringsAsFactors = FALSE
)
sb <- ms_sunburstchart(
  data = dat, path = c("region", "country", "city"), value = "value"
)

doc <- read_pptx()
doc <- add_slide(doc)
#> Warning: Calling `add_slide()` without specifying a `layout` is deprecated.
#>  Please pass a `layout` or use `layout_default()` to set a default.
#>  => I will now continue with the former `layout` default "Title and Content" for backwards compatibility...
doc <- ph_with(doc, sb, location = ph_location_fullsize())
print(doc, target = tempfile(fileext = ".pptx"))