Form table notes

Form table notes

tab_notes(
  notes,
  escape_fun = tab_escape,
  note_config = noteconf(type = "tpt"),
  r_file = getOption("mrg.script", NULL),
  r_file_label = "Source code: ",
  output_file = NULL,
  output_file_label = "Source file: ",
  ...
)

Arguments

notes

a character vector of notes to include at the foot of the table; use r_file and output_file for source code and output file annotations; see tab_notes() for arguments to pass in order to configure the way notes appear in the output; see also st_notes()

escape_fun

a function passed to prime_fun that will sanitize column data

note_config

a noteconf() object used to configure how table notes are displayed; ; see also st_noteconf()

r_file

the name of the R file containing code to generate the table; the file name will be included in the notes in the table footer; ; see also st_files()

r_file_label

a prefix for r_file

output_file

the name of the output file where the table text will be saved; the file name will be included in the notes in the table footer; see also st_files()

output_file_label

a prefix for output_file

...

not used

Examples

tab <- stable(
  stdata(),
  note_config = noteconf(type = "mini")
)