Tables — sbr_tables • subreport

Returns a string of the report tables in markdown format ready for inclusion in a report.

Usage

sbr_tables(
  x_name = ".*",
  sub = character(0),
  report = sbr_get_report(),
  tag = ".*",
  drop = NULL,
  keep = NULL,
  sort = NULL,
  rename = NULL,
  nheaders = 2L,
  header1 = 4L,
  main = subfoldr2::sbf_get_main(),
  sigfig = 4L,
  sigfig_override = NULL,
  md = TRUE,
  pre_num = getOption("sbr.pre_num_tab", 0L)
)

Arguments

x_name: A string of the regular expression to match file names.
sub: A string of the path to the root sub folder.
report: A string of the path to the report folder.
tag: A string of the regular expression that the tag must match to be included.
drop: A character vector specifying the sub folders and file names to exclude from the report or NULL.
keep: A character vector specifying the highest level sub folders to keep that are not in drop. If NULL all highest level subfolders that are not in drop are kept.
sort: A character vector specifying the initial sort order for sub folders and file names or NULL. Missing items appear afterwards in alphabetical order.
rename: A named character vector specifying new heading names for sub folders or NULL. By default sub folder names have the first letter of each word capitalized. Sub folders with the same new heading name are combined under one heading.
nheaders: A count of the number of sub folder levels to assign headers to.
header1: A count of the heading level for the first sub folder level.
main: A string of the path to the main folder.
sigfig: A positive integer of the significant figures to use when formatting numbers. This is applied to all tables unless md = TRUE in which case it is only applied to tables without a .md file.
sigfig_override: A named vector of table names and the number of significant figures to use. This will override the default set in sigfig and the .md file for matching tables.
md: A flag specifying whether to use the .md file of each table saved by subfoldr2::sbf_save_table(), which is rounded following the rounding policy, with the decimal points aligned using figure and punctuation spaces. Tables in sigfig_override and tables without a .md file are formatted using significant figures.
pre_num: A count specifying the number of pre-existing items.

Value

A string of the tables in markdown format.