# Easily Create Presentation-Ready Display Tables

## Documentation for package ‘gt’ version 0.8.0

- DESCRIPTION file.

## Help Pages

A C D E F G H I L M O P R S T V W

## -- A --

adjust_luminance | Adjust the luminance for a palette of colors
as_latex | Output a gt object as LaTeX
as_raw_html | Get the HTML content of a *gt* table
as_rtf | Output a *gt* object as RTF
as_word | Output a *gt* object as Word

## -- C --

cells_body | Location helper for targeting data cells in the table body
cells_column_labels | Location helper for targeting the column labels
cells_column_spanners | Location helper for targeting the column spanners
cells_footnotes | Location helper for targeting the footnotes
cells_grand_summary | Location helper for targeting cells in a grand summary
cells_row_groups | Location helper for targeting row groups
cells_source_notes | Location helper for targeting the source notes
cells_stub | Location helper for targeting cells in the table stub
cells_stubhead | Location helper for targeting the table stubhead cell
cells_stub_grand_summary | Location helper for targeting the stub cells in a grand summary
cells_stub_summary | Location helper for targeting the stub cells in a summary
cells_summary | Location helper for targeting group summary cells
cells_title | Location helper for targeting the table title and subtitle
cell_borders | Helper for defining custom borders for table cells
cell_fill | Helper for defining custom fills for table cells
cell_text | Helper for defining custom text styles for table cells
cols_align | Set the alignment of columns
cols_align_decimal | Align all numeric values in a column along the decimal mark
cols_hide | Hide one or more columns
cols_label | Relabel one or more columns
cols_merge | Merge data from two or more columns to a single column
cols_merge_n_pct | Merge two columns to combine counts and percentages
cols_merge_range | Merge two columns to a value range column
cols_merge_uncert | Merge columns to a value-with-uncertainty column
cols_move | Move one or more columns
cols_move_to_end | Move one or more columns to the end
cols_move_to_start | Move one or more columns to the start
cols_unhide | Unhide one or more columns
cols_width | Set the widths of columns
countrypops | Yearly populations of countries from 1960 to 2017
currency | Supply a custom currency symbol to 'fmt_currency()'

## -- D --

data_color | Set data cell colors using a palette or a color function
default_fonts | A vector of default fonts for use with *gt* tables

## -- E --

escape_latex | Perform LaTeX escaping
exibble | A toy example tibble for testing with gt: exibble
extract_cells | Extract a vector of formatted cells from a *gt* object
extract_summary | Extract a summary list from a *gt* object

## -- F --

fmt | Set a column format with a formatter function
fmt_bytes | Format values as bytes
fmt_currency | Format values as currencies
fmt_date | Format values as dates
fmt_datetime | Format values as datetimes
fmt_duration | Format numeric or duration values as styled time duration strings
fmt_engineering | Format values to engineering notation
fmt_fraction | Format values as a mixed fractions
fmt_integer | Format values as integers
fmt_markdown | Format Markdown text
fmt_number | Format numeric values
fmt_partsper | Format values as parts-per quantities
fmt_passthrough | Format by simply passing data through
fmt_percent | Format values as a percentage
fmt_roman | Format values as Roman numerals
fmt_scientific | Format values to scientific notation
fmt_time | Format values as times

## -- G --

ggplot_image | Helper function for adding a ggplot
google_font | Helper function for specifying a font from the _Google Fonts_ service
grand_summary_rows | Add grand summary rows using aggregation functions
gt | Create a *gt* table object
gtcars | Deluxe automobiles from the 2014-2017 period
gtsave | Save a *gt* table as a file
gt_latex_dependencies | Get the LaTeX dependencies required for a *gt* table
gt_output | Create a *gt* display table output element for Shiny
gt_preview | Preview a *gt* table object

## -- H --

html | Interpret input text as HTML-formatted text

## -- I --

info_currencies | View a table with info on supported currencies
info_date_style | View a table with info on date styles
info_google_fonts | View a table on recommended Google Fonts
info_locales | View a table with info on supported locales
info_paletteer | View a table with info on color palettes
info_time_style | View a table with info on time styles

## -- L --

local_image | Helper function for adding a local image

## -- M --

md | Interpret input text as Markdown-formatted text

## -- O --

opt_align_table_header | Option to align the table header
opt_all_caps | Option to use all caps in select table locations
opt_css | Option to add custom CSS for the table
opt_footnote_marks | Option to modify the set of footnote marks
opt_horizontal_padding | Option to expand or contract horizontal padding
opt_row_striping | Option to add or remove row striping
opt_stylize | Stylize your table with a colorful look
opt_table_font | Option to define a custom font for the table
opt_table_lines | Option to set table lines to different extents
opt_table_outline | Option to wrap an outline around the entire table
opt_vertical_padding | Option to expand or contract vertical padding

## -- P --

pct | Helper for providing a numeric value as percentage
pizzaplace | A year of pizza sales from a pizza place
px | Helper for providing a numeric value as pixels value

## -- R --

random_id | Helper for creating a random 'id' for a *gt* table
render_gt | A *gt* display table render function for use in Shiny
rm_caption | Remove the table caption
rm_footnotes | Remove table footnotes
rm_header | Remove the table header
rm_source_notes | Remove table source notes
rm_spanners | Remove column spanner labels
rm_stubhead | Remove the stubhead label
row_group_order | Modify the ordering of any row groups

## -- S --

sp500 | Daily S&P 500 Index data from 1950 to 2015
stub | Select helper for targeting the stub column
sub_large_vals | Substitute large values in the table body
sub_missing | Substitute missing values in the table body
sub_small_vals | Substitute small values in the table body
sub_values | Substitute targeted values in the table body
sub_zero | Substitute zero values in the table body
summary_rows | Add groupwise summary rows using aggregation functions
sza | Twice hourly solar zenith angles by month & latitude

## -- T --

tab_caption | Add a table caption
tab_footnote | Add a table footnote
tab_header | Add a table header
tab_info | Understand what's been set inside of a *gt* table object
tab_options | Modify the table output options
tab_row_group | Add a row group to a *gt* table
tab_source_note | Add a source note citation
tab_spanner | Add a spanner column label
tab_spanner_delim | Create column labels and spanners via delimited names
tab_stubhead | Add label text to the stubhead
tab_stub_indent | Control indentation of row labels in the stub
tab_style | Add custom styles to one or more cells
tab_style_body | Target cells in the table body and style accordingly
test_image | Generate a path to a test image
text_transform | Perform targeted text transformation with a function

## -- V --

vec_fmt_bytes | Format a vector as values in terms of bytes
vec_fmt_currency | Format a vector as currency values
vec_fmt_date | Format a vector as date values
vec_fmt_datetime | Format a vector as datetime values
vec_fmt_duration | Format a vector of numeric or duration values as styled time duration strings
vec_fmt_engineering | Format a vector as values in engineering notation
vec_fmt_fraction | Format a vector as mixed fractions
vec_fmt_integer | Format a vector as integer values
vec_fmt_markdown | Format a vector containing Markdown text
vec_fmt_number | Format a vector as numeric values
vec_fmt_partsper | Format a vector as parts-per quantities
vec_fmt_percent | Format a vector as percentage values
vec_fmt_roman | Format a vector as Roman numerals
vec_fmt_scientific | Format a vector as values in scientific notation
vec_fmt_time | Format a vector as time values

## -- W --

web_image | Helper function for adding an image from the web