Skip to contents

Set or merge individual column-header cells (deprecated)

Source: R/style_verbs.R
set_header_cell.Rd

Deprecated in 0.8.x (warns once a session, still works); removed in 0.9.0. Restyle a header's cells with style_header(), and write a spanning cell into the header itself (rtf_col_header() / set_col_header(), or add_header_row() for a new row).

Usage

set_header_cell(x, ...)

# S3 method for class 'rtftable'
set_header_cell(x, ..., row)

# S3 method for class 'list'
set_header_cell(x, ...)

Arguments

x

An rtftable(), or a list of them (pages from as_rtftables()).

...

One or more col_cell() objects to place in row. Their pos may be column names or positions (spanning via c(a, b)), resolved against the final columns; align / border / bold / italic / underline are applied to the cell.

row

The header row to edit (1 = top). Must be an existing row – add a new row with add_header_row().

Value

An object of the same shape as x.

Details

Edits specific cells of one header row of a finished rtftable() (or a list of pages) without rebuilding the whole header: place one or more col_cell()s – by column name or position, spanning via c(a, b) – into row row, keeping the other cells of that row intact. Merging currently-separate cells into one spanning cell is the core use. Borders, alignment and text decorations are carried natively by col_cell().

A label row is promoted to cells first (as in style_header()), so the row then renders through the spanning border zone (which falls back to the header zone when unset). Merging cells in one row replaces their individual labels with the single span label – to keep the sub-labels, put the span on a separate upper row (e.g. via add_header_row()).

Rules

Each target span must align to existing cell boundaries in that row (it cannot split an existing spanning cell – an error is raised otherwise), and the requested cells must not overlap one another.

See also

set_col_header() to set the whole header; style_header() to restyle existing cells; add_header_row() to add a row; col_cell().

Examples

# instead: the spanning cell written in the header
df  <- data.frame(Item = "x", g1 = 1, g2 = 2, g3 = 3, Total = 4)
tbl <- rtftable(df, col_header = rtf_col_header(
  list(col_cell(1, ""), col_cell(c(2, 4), "Statistics"), col_cell(5, "")),
  c("Item", "N", "Mean", "SD", "Total")))