cols_move_to_end: Move one or more columns to the end

View source: R/modify_columns.R

cols_move_to_endR Documentation

Move one or more columns to the end

Description

It's possible to move a set of columns to the end of the column series, we only need to specify which columns are to be moved. While this can be done upstream of gt, this function makes to process much easier and it's less error prone. The ordering of the columns that are moved to the end is preserved (same with the ordering of all other columns in the table).

Usage

cols_move_to_end(data, columns)

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 for which the moving operations should be applied. 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(). The columns move as a group to the right-most side of the table. The order of the remaining columns will be preserved.

Details

The columns supplied in columns must all exist in the table. If you need to place one or columns at the start of the column series, the cols_move_to_start() function should be used. More control is offered with the cols_move() function, where columns could be placed after a specific column.

Value

An object of class gt_tbl.

Examples

For this example, we'll use a portion of the countrypops dataset to create a simple gt table. Let's move the year column, which is the middle column, to the end of the column series with the cols_move_to_end() function.

countrypops |>
  dplyr::select(-contains("code")) |>
  dplyr::filter(country_name == "Benin") |>
  dplyr::slice_tail(n = 5) |>
  gt() |>
  cols_move_to_end(columns = year)
This image of a table was generated from the first code example in the `cols_move_to_end()` help file.

We can also move multiple columns at a time. With the same countrypops-based table, let's move both the year and population columns to the end of the column series.

countrypops |>
  dplyr::select(-contains("code")) |>
  dplyr::filter(country_name == "Benin") |>
  dplyr::slice_tail(n = 5) |>
  gt() |>
  cols_move_to_end(columns = c(year, country_name))
This image of a table was generated from the second code example in the `cols_move_to_end()` help file.

Function ID

5-11

Function Introduced

v0.2.0.5 (March 31, 2020)

See Also

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_start(), cols_move(), cols_nanoplot(), cols_unhide(), cols_units(), cols_width()


gt documentation built on Oct. 7, 2023, 9:07 a.m.