gt R Package Documentation

The gt workflow follows a consistent pattern:

1. Table Data: Start with a tibble or data.frame.
2. Composition: Use gt() to create the table object, then compose it using a cohesive set of table parts such as the table header, stub, column labels, spanner column labels, table body, and table footer.
3. Rendering: Render the table by printing it to the console, including it in an R Markdown document, or exporting it to a file using gtsave().

Supported output formats include HTML, LaTeX, and RTF.

Examples for the gt package are collected and rendered as Quarto websites. You can browse these examples at the following locations to see various ways to use the package:

• https://quarto-gt-examples.netlify.app/
• https://colorado.posit.co/rsc/gt_package/

You can install the stable version of gt from CRAN or the development version from GitHub.

From CRAN:

install.packages("gt")

From GitHub (development version):

devtools::install_github("rstudio/gt")

This example demonstrates the standard workflow: filtering data, initializing a gt table, adding a header, and applying specific formatting to columns (currency, dates, and numbers).

library(gt)

# Define the start and end dates for the data range
start_date <- "2010-06-07"
end_date <- "2010-06-14"

# Create a gt table based on preprocessed
# `sp500` table data
sp500 |>
  dplyr::filter(date >= start_date & date <= end_date) |>
  dplyr::select(-adj_close) |>
  gt() |>
  tab_header(
    title = "S&P 500",
    subtitle = glue::glue("{start_date} to {end_date}")
  ) |>
  fmt_currency() |>
  fmt_date(columns = date, date_style = "wd_m_day_year") |>
  fmt_number(columns = volume, suffixing = TRUE)