Modify column indentation

Add, increase or reduce the indentation of cells. By default the level and missing-value rows of the label column are indented by 4 spaces.

Usage

modify_indent(x, columns, rows = NULL, indent = 4L)

Arguments

x

(ltsummary)
An ltsummary object.

columns

(selector)
Columns of x$table_body.

rows

(predicate expression)
Expression selecting rows of x$table_body, e.g. row_type == "label". Used for footnotes, formatting functions, missing symbols, indentation and text formatting. Default is NULL, which selects every row (or, for a footnote, places it in the column header). See the section below.

indent

(integer)
Number of spaces of indentation. Default is 4L; 0L removes indentation.

Value

An ltsummary object.

rows argument

The rows argument is a predicate expression that selects the rows the styling applies to. It is evaluated in x$table_body, so its column names are available as variables, and it must give a logical vector. To style the rows of the age variable pass rows = variable == "age"; to style the variable label rows pass rows = row_type == "label". A logical vector, a vector of row numbers or a function of table_body are also accepted.

Objects from the calling environment can be used in the expression, e.g. rows = variable == vars[1], as long as they do not share a name with a column of x$table_body. The expression is stored, not its result, and resolved when the table is printed, so it survives later changes to the table such as remove_row_type().

See also

Other advanced modifiers: modify_bold_italic, modify_column_alignment(), modify_column_hide(), modify_column_merge(), modify_fmt_fun(), modify_missing_symbol(), modify_post_fmt_fun(), tbl_butcher()

Examples

# Example 1 ----------------------------------
# remove the indentation of the levels
trial |>
  tbl_summary(include = grade) |>
  modify_indent(columns = label, indent = 0L)

# Example 2 ----------------------------------
# indent the levels further
trial |>
  tbl_summary(include = grade) |>
  modify_indent(columns = label, rows = row_type != "label", indent = 8L)