Guide Overview

Welcome to the tabviz guide. This section takes you from installation to advanced features in a logical progression.

Installation

# Install from GitHub using pak
install.packages("pak")
pak::pak("kaskarn/tabviz")

Learning Path

The guide is organized as a linear progression, with each chapter building on the previous:

flowchart LR
    A["Quick Start"] --> B["Columns"]
    B --> C["Styling"]
    C --> D["Groups"]
    D --> E["Forest Plots"]
    E --> F["Advanced"]

    style A fill:#4f46e5,color:#fff

Getting Started

Chapter What You’ll Learn
Quick Start Create your first table in under a minute
Columns Choose and configure column types

Styling

Chapter What You’ll Learn
Row Styling Bold, italic, colors, indentation
Cell Styling Conditional formatting per-cell
Row Groups Collapsible hierarchical sections

Visualizations

Chapter What You’ll Learn
Forest Plots Add interval visualizations with viz_forest()
Split Plots Sidebar navigation for subgroups

Customization & Output

Chapter What You’ll Learn
Themes Preset themes and customization
Shiny Integration Reactive tables in Shiny apps
Export Save to SVG, PNG, or PDF

Two Entry Points

tabviz offers two main functions:

tabviz() - Full Control

Use for any table type with explicit column definitions:

tabviz(data,
  label = "study",
  columns = list(
    col_text("category"),
    col_numeric("value"),
    viz_forest(point = "hr", lower = "lo", upper = "hi"),
    col_sparkline("trend")
  )
)

forest_plot() - Quick Forest Plots

Convenience wrapper when you just need point/lower/upper:

forest_plot(data,
  point = "hr",
  lower = "lower",
  upper = "upper",
  label = "study",
  scale = "log",
  null_value = 1
)

Quick Reference

For a condensed overview of all functions and arguments, see the Cheatsheet.

Concepts

To understand the architecture and design patterns, see Concepts.

Getting Help