Hide one or more rows

rows_hide() allows us to hide one or more rows from appearing in the final output table. While it's possible and often desirable to omit rows from the input table data before introduction to gt(), there can be cases where the data in certain rows is useful (as a row reference during formatting of other rows or for column-based aggregations) but the final display of those rows is not necessary.

Usage

rows_hide(data, rows)

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.

rows

Rows to target

<row-targeting expression> // required

The rows to hide in the output display table. Can either be a series of row IDs provided in c(), a vector of row indices, or a select helper function (e.g. starts_with(), ends_with(), contains(), matches(), num_range(), and everything()). We can also use expressions to filter down to the rows we need (e.g., [column_1] > 100 & [column_2] < 50).

Value

An object of class gt_tbl.

Details

The hiding of rows is internally a rendering directive, so, all rows that are 'hidden' are still accessible and useful in any expression provided to a columns argument (for column-level operations). Furthermore, rows_hide() (as with many gt functions) can be placed anywhere in a pipeline of gt function calls (acting as a promise to hide rows when the timing is right). However, there's perhaps greater readability when placing this call closer to the end of such a pipeline.

rows_hide() quietly changes the visible state of a row (much like rows_unhide()) and doesn't yield warnings or messages when changing the state of already-hidden rows.

Examples

Let's use a small portion of the countrypops dataset to create a gt table. We can hide rows where the population is below a certain threshold using rows_hide().

countrypops |>
  dplyr::filter(
    country_name == "Egypt",
    year %in% 2017:2021
  ) |>
  gt(rowname_col = "year") |>
  fmt_integer(columns = population) |>
  rows_hide(rows = population < 100E6)

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

Using another countrypops-based gt table, we can hide specific rows by targeting them with their row labels (from the stub). Note that the footnote placement still works correctly, skipping the hidden rows in its mark indexing.

countrypops |>
  dplyr::filter(
    country_name == "Brazil",
    year %in% 2017:2021
  ) |>
  gt(rowname_col = "year") |>
  fmt_integer(columns = population) |>
  rows_hide(rows = c("2018", "2020")) |>
  tab_footnote(
    footnote = "Population above 210,000,000.",
    locations = cells_body(
      columns = population,
      rows = population > 210E6
    )
  )

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

Function ID

6-7

Function Introduced

In Development