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.
Arguments
- data
The gt table data object
obj:<gt_tbl>
// requiredThis 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 includestarts_with()
,ends_with()
,contains()
,matches()
,one_of()
,num_range()
, andeverything()
.
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.
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
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)
See also
cols_hide()
to perform the inverse operation.
Other column modification functions:
cols_add()
,
cols_align_decimal()
,
cols_align()
,
cols_hide()
,
cols_label_with()
,
cols_label()
,
cols_merge_n_pct()
,
cols_merge_range()
,
cols_merge_uncert()
,
cols_merge()
,
cols_move_to_end()
,
cols_move_to_start()
,
cols_move()
,
cols_nanoplot()
,
cols_units()
,
cols_width()