| fmt_time {gt} | R Documentation |
Format values as times
Description
Format input values to time values using one of 25 preset time styles. Input
can be in the form of POSIXt (i.e., datetimes), character (must be in the
ISO 8601 forms of HH:MM:SS or YYYY-MM-DD HH:MM:SS), or Date (which
always results in the formatting of 00:00:00).
Usage
fmt_time(
data,
columns = everything(),
rows = everything(),
time_style = "iso",
pattern = "{x}",
locale = NULL
)
Arguments
data |
The gt table data object
This is the gt table object that is commonly created through use of the
|
columns |
Columns to target
Can either be a series of column names provided in |
rows |
Rows to target
In conjunction with |
time_style |
Predefined style for times
The time style to use. By default this is the short name |
pattern |
Specification of the formatting pattern
A formatting pattern that allows for decoration of the formatted value. The
formatted value is represented by the |
locale |
Locale identifier
An optional locale identifier that can be used for formatting values
according the locale's rules. Examples include |
Value
An object of class gt_tbl.
Compatibility of formatting function with data values
fmt_time() is compatible with body cells that are of the "Date",
"POSIXt" or "character" types. Any other types of body cells are ignored
during formatting. This is to say that cells of incompatible data types may
be targeted, but there will be no attempt to format them.
Targeting cells with columns and rows
Targeting of values is done through columns and additionally by rows (if
nothing is provided for rows then entire columns are selected). The
columns argument allows us to target a subset of cells contained in the
resolved columns. We say resolved because aside from declaring column names
in c() (with bare column names or names in quotes) we can use
tidyselect-style expressions. This can be as basic as supplying a select
helper like starts_with(), or, providing a more complex incantation like
where(~ is.numeric(.x) && max(.x, na.rm = TRUE) > 1E6)
which targets numeric columns that have a maximum value greater than
1,000,000 (excluding any NAs from consideration).
By default all columns and rows are selected (with the everything()
defaults). Cell values that are incompatible with a given formatting function
will be skipped over, like character values and numeric fmt_*()
functions. So it's safe to select all columns with a particular formatting
function (only those values that can be formatted will be formatted), but,
you may not want that. One strategy is to format the bulk of cell values with
one formatting function and then constrain the columns for later passes with
other types of formatting (the last formatting done to a cell is what you get
in the final output).
Once the columns are targeted, we may also target the rows within those
columns. This can be done in a variety of ways. If a stub is present, then we
potentially have row identifiers. Those can be used much like column names in
the columns-targeting scenario. We can use simpler tidyselect-style
expressions (the select helpers should work well here) and we can use quoted
row identifiers in c(). It's also possible to use row indices (e.g.,
c(3, 5, 6)) though these index values must correspond to the row numbers of
the input data (the indices won't necessarily match those of rearranged rows
if row groups are present). One more type of expression is possible, an
expression that takes column values (can involve any of the available columns
in the table) and returns a logical vector. This is nice if you want to base
formatting on values in the column or another column, or, you'd like to use a
more complex predicate expression.
Compatibility of arguments with the from_column() helper function
from_column() can be used with certain arguments of fmt_time() to obtain
varying parameter values from a specified column within the table. This means
that each row could be formatted a little bit differently. These arguments
provide support for from_column():
-
time_style -
pattern -
locale
Please note that for each of the aforementioned arguments, a from_column()
call needs to reference a column that has data of the correct type (this is
different for each argument). Additional columns for parameter values can be
generated with cols_add() (if not already present). Columns that contain
parameter data can also be hidden from final display with cols_hide().
Finally, there is no limitation to how many arguments the from_column()
helper is applied so long as the arguments belong to this closed set.
Formatting with the time_style argument
We need to supply a preset time style to the time_style argument. There are
many time styles and all of them can handle localization to any supported
locale. Many of the time styles are termed flexible time formats and this
means that their output will adapt to any locale provided. That feature
makes the flexible time formats a better option for locales other than "en"
(the default locale).
The following table provides a listing of all time styles and their output
values (corresponding to an input time of 14:35:00). It is noted which of
these represent 12- or 24-hour time.
| Time Style | Output | Notes | |
| 1 | "iso" | "14:35:00" | ISO 8601, 24h |
| 2 | "iso-short" | "14:35" | ISO 8601, 24h |
| 3 | "h_m_s_p" | "2:35:00 PM" | 12h |
| 4 | "h_m_p" | "2:35 PM" | 12h |
| 5 | "h_p" | "2 PM" | 12h |
| 6 | "Hms" | "14:35:00" | flexible, 24h |
| 7 | "Hm" | "14:35" | flexible, 24h |
| 8 | "H" | "14" | flexible, 24h |
| 9 | "EHm" | "Thu 14:35" | flexible, 24h |
| 10 | "EHms" | "Thu 14:35:00" | flexible, 24h |
| 11 | "Hmsv" | "14:35:00 GMT+00:00" | flexible, 24h |
| 12 | "Hmv" | "14:35 GMT+00:00" | flexible, 24h |
| 13 | "hms" | "2:35:00 PM" | flexible, 12h |
| 14 | "hm" | "2:35 PM" | flexible, 12h |
| 15 | "h" | "2 PM" | flexible, 12h |
| 16 | "Ehm" | "Thu 2:35 PM" | flexible, 12h |
| 17 | "Ehms" | "Thu 2:35:00 PM" | flexible, 12h |
| 18 | "EBhms" | "Thu 2:35:00 in the afternoon" | flexible, 12h |
| 19 | "Bhms" | "2:35:00 in the afternoon" | flexible, 12h |
| 20 | "EBhm" | "Thu 2:35 in the afternoon" | flexible, 12h |
| 21 | "Bhm" | "2:35 in the afternoon" | flexible, 12h |
| 22 | "Bh" | "2 in the afternoon" | flexible, 12h |
| 23 | "hmsv" | "2:35:00 PM GMT+00:00" | flexible, 12h |
| 24 | "hmv" | "2:35 PM GMT+00:00" | flexible, 12h |
| 25 | "ms" | "35:00" | flexible |
We can call info_time_style() in the console to view a similar table of
time styles with example output.
Adapting output to a specific locale
This formatting function can adapt outputs according to a provided locale
value. Examples include "en" for English (United States) and "fr" for
French (France). Note that a locale value provided here will override any
global locale setting performed in gt()'s own locale argument (it is
settable there as a value received by all other functions that have a
locale argument). As a useful reference on which locales are supported, we
can use info_locales() to view an info table.
Examples
Let's use the exibble dataset to create a simple, two-column gt table
(keeping only the date and time columns). Format the time column with
fmt_time() to display times formatted with the "h_m_s_p" time style.
exibble |>
dplyr::select(date, time) |>
gt() |>
fmt_time(
columns = time,
time_style = "h_m_s_p"
)
Again using the exibble dataset, let's format the time column to have
mixed time formats, where times after 16:00 will be different than the others
because of the expressions used in the rows argument. This will involve two
calls of fmt_time() with different statements provided for rows. In the
first call (times after 16:00) the time style "h_m_s_p" is used; for the
second call, "h_m_p" is the named time style supplied to time_style.
exibble |>
dplyr::select(date, time) |>
gt() |>
fmt_time(
columns = time,
rows = time > "16:00",
time_style = "h_m_s_p"
) |>
fmt_time(
columns = time,
rows = time <= "16:00",
time_style = "h_m_p"
)
Use the exibble dataset to create a single-column gt table (with only
the time column). Format the time values using the "EBhms" time style
(which is one of the 'flexible' styles). Also, we'll set the locale to "sv"
to get the times in Swedish.
exibble |>
dplyr::select(time) |>
gt() |>
fmt_time(
columns = time,
time_style = "EBhms",
locale = "sv"
)
Function ID
3-14
Function Introduced
v0.2.0.5 (March 31, 2020)
See Also
The vector-formatting version of this function: vec_fmt_time().
Other data formatting functions:
data_color(),
fmt(),
fmt_auto(),
fmt_bins(),
fmt_bytes(),
fmt_chem(),
fmt_country(),
fmt_currency(),
fmt_date(),
fmt_datetime(),
fmt_duration(),
fmt_email(),
fmt_engineering(),
fmt_flag(),
fmt_fraction(),
fmt_icon(),
fmt_image(),
fmt_index(),
fmt_integer(),
fmt_markdown(),
fmt_number(),
fmt_partsper(),
fmt_passthrough(),
fmt_percent(),
fmt_roman(),
fmt_scientific(),
fmt_spelled_num(),
fmt_tf(),
fmt_units(),
fmt_url(),
sub_large_vals(),
sub_missing(),
sub_small_vals(),
sub_values(),
sub_zero()