cols_unhide: Unhide one or more columns

Description

The cols_unhide() function allows us to take one or more hidden columns (usually made so via the cols_hide() function) and make them visible in the final output table. This may be important in cases where the user obtains a gt_tbl object with hidden columns and there is motivation to reveal one or more of those.

Usage

cols_unhide(data, columns)

Value

An object of class gt_tbl.

Arguments

data

The gt table data object

obj:<gt_tbl> // required

This is the gt table object that is commonly created through use of the gt() function.

columns

Columns to target

<column-targeting expression> // default: everything()

The columns to unhide in the output display table. Can either be a series of column names provided in c(), a vector of column indices, or a select helper function. Examples of select helper functions include starts_with(), ends_with(), contains(), matches(), one_of(), num_range(), and everything().

Examples

Let's use a small portion of the countrypops dataset to create a gt table. We'll hide the country_code_2 and country_code_3 columns with the cols_hide() function.

tab_1 <-
  countrypops |>
  dplyr::filter(country_name == "Singapore") |>
  dplyr::slice_tail(n = 5) |>
  gt() |>
  cols_hide(columns = c(country_code_2, country_code_3))
tab_1

This image of a table was generated from the first code example in the `cols_unhide()` help file.

If the tab_1 object is provided without the code or source data to regenerate it, and, the user wants to reveal otherwise hidden columns then the cols_unhide() function becomes useful.

tab_1 |> cols_unhide(columns = country_code_2)

This image of a table was generated from the second code example in the `cols_unhide()` help file.

Function ID

5-13

Function Introduced

v0.3.0 (May 12, 2021)

Details

The hiding and unhiding of columns is internally a rendering directive, so, all columns that are 'hidden' are still accessible and useful in any expression provided to a rows argument. The cols_unhide() function quietly changes the visible state of a column (much like the cols_hide() function) and doesn't yield warnings or messages when changing the state of already-visible columns.