We can easily move set of columns to the beginning of the column series and
we only need to specify which columns
. It's possible to do this upstream of
gt, however, it is easier with this function and it presents less
possibility for error. The ordering of the columns
that are moved to the
start is preserved (same with the ordering of all other columns in the
table).
cols_move_to_start(data, columns)
An object of class gt_tbl
.
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 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
left-most side of the table. The order of the remaining columns will be
preserved.
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 start of the column series with the
cols_move_to_start()
function.
countrypops |>
dplyr::select(-contains("code")) |>
dplyr::filter(country_name == "Fiji") |>
dplyr::slice_tail(n = 5) |>
gt() |>
cols_move_to_start(columns = year)
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 start of the column series.
countrypops |>
dplyr::select(-contains("code")) |>
dplyr::filter(country_name == "Fiji") |>
dplyr::slice_tail(n = 5) |>
gt() |>
cols_move_to_start(columns = c(year, population))
5-10
v0.2.0.5
(March 31, 2020)
The columns supplied in columns
must all exist in the table. If you need to
place one or columns at the end of the column series, the
cols_move_to_end()
function should be used. More control is offered with
the cols_move()
function, where columns could be placed after a specific
column.
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()
,
cols_nanoplot()
,
cols_unhide()
,
cols_units()
,
cols_width()