modify_table_styling: Modify Table Styling

Description Usage Arguments Details rows argument See Also

View source: R/modify_table_styling.R

Description

This is a function meant for advanced users to gain more control over the characteristics of the resulting gtsummary table by directly modifying .$table_styling

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
modify_table_styling(
  x,
  columns,
  rows = NULL,
  label = NULL,
  spanning_header = NULL,
  hide = NULL,
  footnote = NULL,
  footnote_abbrev = NULL,
  align = NULL,
  missing_symbol = NULL,
  fmt_fun = NULL,
  text_format = NULL,
  undo_text_format = FALSE,
  text_interpret = c("md", "html")
)

Arguments

x

gtsummary object

columns

vector or selector of columns in x$table_body

rows

predicate expression to select rows in x$table_body. Can be used to style footnote, formatting functions, missing symbols, and text formatting. Default is NULL. See details below.

label

string of column label(s)

spanning_header

string with text for spanning header

hide

logical indicating whether to hide column from output

footnote

string with text for footnote

footnote_abbrev

string with abbreviation definition, e.g. "CI = Confidence Interval"

align

string indicating alignment of column, must be one of c("left", "right", "center")

missing_symbol

string indicating how missing values are formatted.

fmt_fun

function that formats the statistics in the columns/rows in columns= and rows=

text_format

string indicated which type of text formatting to apply to the rows and columns. Must be one of c("bold", "italic", "indent")

undo_text_format

rarely used. Logical that undoes the indent, bold, and italic styling when TRUE

text_interpret

string, must be one of "md" or "html"

Details

Review the gtsummary definition vignette for information on .$table_styling objects.

rows argument

The rows argument accepts a predicate expression that is used to specify rows to apply formatting. The expression must evaluate to a logical when evaluated in x$table_body. For example, to apply formatting to the age rows pass rows = variable == "age". A vector of row numbers is NOT acceptable.

A couple of things to note when using the rows= argument.

  1. You can use saved objects to create the predicate argument, e.g. rows = variable == letters[1].

  2. The saved object cannot share a name with a column in x$table_body. The reason for this is that in tbl_merge() the columns are renamed, and the renaming process cannot disambiguate the variable column from an external object named variable in the following expression rows = .data$variable = .env$variable.

See Also

modify_table_body()

See gtsummary internals vignette


ddsjoberg/gtsummary documentation built on April 8, 2021, 5:48 a.m.