google_font: Helper function for specifying a font from the _Google Fonts_...

View source: R/helpers.R

google_fontR Documentation

Helper function for specifying a font from the Google Fonts service

Description

google_font() can be used wherever a font name should be specified. There are two instances where this helper can be used: the name argument in opt_table_font() (for setting a table font) and in that of cell_text() (used with tab_style()). To get a helpful listing of fonts that work well in tables, call info_google_fonts().

Usage

google_font(name)

Arguments

name

Google Font name

⁠scalar<character>⁠ // required

The complete name of a font available in Google Fonts.

Value

An object of class font_css.

Examples

Use the exibble dataset to create a gt table of two columns and eight rows. We'll replace missing values with em dashes using sub_missing(). For text in the time column, we will use the font called "IBM Plex Mono" which is available in Google Fonts. This is defined inside the google_font() call, itself part of a vector that includes fonts returned by default_fonts() (those fonts will serve as fallbacks just in case the font supplied by Google Fonts is not accessible). In terms of placement, all of this is given to the font argument of cell_text() which is itself given to the style argument of tab_style().

exibble |>
  dplyr::select(char, time) |>
  gt() |>
  sub_missing() |>
  tab_style(
    style = cell_text(
      font = c(
        google_font(name = "IBM Plex Mono"),
        default_fonts()
      )
    ),
    locations = cells_body(columns = time)
  )
This image of a table was generated from the first code example in the `google_font()` help file.

We can use a subset of the sp500 dataset to create a small gt table. With fmt_currency(), we can display a dollar sign for the first row of the monetary values. Then, we'll set a larger font size for the table and opt to use the "Merriweather" font by calling google_font() within opt_table_font(). In cases where that font may not materialize, we include two font fallbacks: "Cochin" and the catchall "Serif" group.

sp500 |>
  dplyr::slice(1:10) |>
  dplyr::select(-volume, -adj_close) |>
  gt() |>
  fmt_currency(
    rows = 1,
    currency = "USD",
    use_seps = FALSE
  ) |>
  tab_options(table.font.size = px(20)) |>
  opt_table_font(
    font = list(
      google_font(name = "Merriweather"),
      "Cochin", "Serif"
    )
  )
This image of a table was generated from the second code example in the `google_font()` help file.

Function ID

8-31

Function Introduced

v0.2.2 (August 5, 2020)

See Also

Other helper functions: adjust_luminance(), cell_borders(), cell_fill(), cell_text(), currency(), default_fonts(), escape_latex(), from_column(), gt_latex_dependencies(), html(), md(), nanoplot_options(), pct(), px(), random_id(), row_group(), stub(), system_fonts(), unit_conversion()


gt documentation built on Sept. 11, 2024, 5:15 p.m.