Create a treemap visualization — viz

Creates an interactive treemap using highcharter for hierarchical data. Treemaps are useful for showing proportional data in a space-efficient way.

Usage

viz_treemap(
  data,
  group_var,
  subgroup_var = NULL,
  value_var,
  color_var = NULL,
  title = NULL,
  subtitle = NULL,
  color_palette = NULL,
  height = 500,
  allow_drill_down = TRUE,
  layout_algorithm = "squarified",
  data_labels_enabled = TRUE,
  show_labels = NULL,
  label_style = NULL,
  tooltip = NULL,
  tooltip_format = NULL,
  credits = FALSE,
  pre_aggregated = FALSE,
  ...
)

Arguments

data: Data frame containing the data
group_var: Primary grouping variable (e.g., "region")
subgroup_var: Optional secondary grouping variable (e.g., "city")
value_var: Variable for sizing the rectangles (e.g., "spend")
color_var: Optional variable for coloring (defaults to group_var)
title: Chart title
subtitle: Chart subtitle
color_palette: Named vector of colors or palette name
height: Chart height in pixels (default 500)
allow_drill_down: Whether to allow drilling into subgroups (default TRUE)
layout_algorithm: Layout algorithm: "squarified" (default), "strip", "sliceAndDice", "stripes"
data_labels_enabled: Logical. If TRUE, show data labels on cells. Default TRUE.
show_labels: Deprecated. Use data_labels_enabled instead.
label_style: List of label styling options
tooltip: A tooltip configuration created with tooltip(), OR a format string with {placeholders}. Available placeholders: {name}, {value}. See tooltip for full customization options.
tooltip_format: Custom tooltip format using Highcharts syntax (legacy). For the simpler dashboardr placeholder syntax, use tooltip instead.
credits: Whether to show Highcharts credits (default FALSE)
pre_aggregated: Logical. If TRUE, skips summing and uses value_var directly. Use this when your data is already aggregated (one row per leaf node). Default is FALSE.
...: Additional parameters passed to highcharter

Value

A highcharter treemap object

Examples

if (FALSE) { # \dontrun{
# Simple treemap
data <- data.frame(
  region = c("North", "North", "South", "South"),
  city = c("NYC", "Boston", "Miami", "Atlanta"),
  spend = c(1000, 500, 800, 600)
)
viz_treemap(data, group_var = "region", subgroup_var = "city", value_var = "spend")

# Single-level treemap
viz_treemap(data, group_var = "city", value_var = "spend", title = "Spend by City")
} # }