Create a gt table objectSource:
gt() function creates a gt table object when provided with table
data. Using this function is the first step in a typical gt workflow.
Once we have the gt table object, we can perform styling transformations
before rendering to a display table of various formats.
data.frameobject or a tibble.
The column name in the input
datatable to use as row captions to be placed in the display table stub. If the
TRUEthen any column name provided to
rowname_colwill be ignored.
The column name in the input
datatable to use as group labels for generation of stub row groups. If the input
datatable has the
grouped_dfclass (through use of the
dplyr::group_by()function or associated
group_by*()functions) then any input here is ignored.
An optional table caption to use for cross-referencing in R Markdown documents and bookdown book projects.
An option to take rownames from the input
datatable as row captions in the display table stub.
Optionally have column data be aligned depending on the content contained in each column of the input
data. Internally, this calls
cols_align(align = "auto")for all columns.
The table ID. By default, with
NULL, this will be a random, ten-letter ID as generated by using the
random_id()function. A custom table ID can be used with any single-length character vector.
An optional locale ID that can be set as the default locale for all functions that take a
localeargument. Examples of valid locales include
"en_US"for English (United States) and
"fr_FR"for French (France). Refer to the information provided by the
info_locales()to determine which locales are supported.
The separator to use between consecutive group names (a possibility when providing
grouped_dfwith multiple groups) in the displayed stub row group label.
There are a few data ingest options we can consider at this stage. We can
choose to create a table stub with rowname captions using the
argument. Further to this, stub row groups can be created with the
groupname_col. Both arguments take the name of a column in the input table
data. Typically, the data in the
groupname_col will consist of categories
of data in a table and the data in the
rowname_col are unique labels
(perhaps unique across the entire table or unique within groups).
Row groups can also be created by passing a
gt() by using
dplyr::group_by() function on the table data. In this way, two or more
columns of categorical data can be used to make row groups. The
row_group.sep argument allows for control in how the row group label will
appear in the display table.
Create a gt table object using the
exibble dataset. Use the
group columns to add a stub and row groups via the
The resulting gt table object can be used in transformations with a
cols_*(), and even more functions
available in the package.
tab_1 %>% tab_header( title = "Table Title", subtitle = "Subtitle" ) %>% fmt_number( columns = num, decimals = 2 ) %>% cols_label(num = "number")
Other table creation functions: