span_table: Spread Large Table Over Smaller Tables

Description

Takes a large table and spreads it over smaller tables to paginate it. It will preserve common row information on the left and separate columns according to maximum specifications. The final tables will have widths less than or equal to both max_col and max_width, and heights less than or equal to both max_row and max_height.

Usage

span_table(
  table_body = NULL,
  row_common = NULL,
  table_body_head = NULL,
  row_common_head = NULL,
  header_format = "text",
  obnd = NULL,
  max_row = 20,
  max_col = 10,
  max_height = 7,
  max_width = 6.5,
  table_alignment = "center",
  inner_border = officer::fp_border(color = "black", width = 0.3),
  outer_border = officer::fp_border(color = "black", width = 2),
  set_header_inner_border_v = TRUE,
  set_header_inner_border_h = TRUE,
  set_header_outer_border = TRUE,
  set_body_inner_border_v = TRUE,
  set_body_inner_border_h = FALSE,
  set_body_outer_border = TRUE,
  notes_detect = NULL
)

Value

list with the following elements

isgood: Boolean indicating the exit status of the function.
one_body: Full table with no headers.
one_table: Full table with headers.
msgs: Vector of text messages describing any errors that were found.
tables: Named list of tables. Each list element is of the output. format from build_span().

Arguments

table_body: Data frame with the body of the large table.
row_common: Data frame with the common rows.
table_body_head: Data frame or matrix with headers for the table body.
row_common_head: Data frame or matrix with headers for the common rows.
header_format: Format of the header either "text" (default) or "md" for markdown.
obnd: Optional onbrand object used to format markdown. The default NULL value will use default formatting.
max_row: Maximum number of rows in output tables (A value of NULL will set max_row to the number of rows in the table).
max_col: Maximum number of columns in output tables (A value of NULL will set max_col to number of columns in the table).
max_height: Maximum height of the final table in inches (A value of NULL will use 100 inches).
max_width: Maximum width of the final table in inches (A value of NULL will use 100 inches).
table_alignment: Character string specifying the alignment #'of the table (body and headers). Can be "center" (default), "left", "right", or "justify"
inner_border: Border object for inner border lines defined using officer::fp_border()
outer_border: Border object for outer border lines defined using officer::fp_border()
set_header_inner_border_v: Boolean value to enable or disable inner vertical borders for headers
set_header_inner_border_h: Boolean value to enable or disable inner horizontal borders for headers
set_header_outer_border: Boolean value to enable or disable outer border for headers
set_body_inner_border_v: Boolean value to enable or disable inner vertical borders for the body
set_body_inner_border_h: Boolean value to enable or disable inner horizontal borders for the body
set_body_outer_border: Boolean value to enable or disable outer border borders for the body
notes_detect: Vector of strings to detect in output tables (example c("NC", "BLQ")).

Details

The way the data frames relate to each other are mapped out below. The dimensions of the different data frames are identified below (nrow x ncol)


 |-------------------------------------| ---
 |                 |                   |  ^
 |                 |                   |  |
 | row_common_head |  table_body_head  |  | m
 |      m x n      |       m x c       |  |
 |                 |                   |  v
 |-------------------------------------| ---
 |                 |                   |  ^
 |                 |                   |  |
 |    row_common   |    table_body     |  | r
 |      r x n      |      r x c        |  |
 |                 |                   |  |
 |                 |                   |  v
 |-------------------------------------| ---
 |<--------------->|<----------------->|
         n                   c

Examples

Run this code

if(interactive()){

tbl_res = mk_lg_tbl()

res =
span_table(table_body      = tbl_res$lg_tbl_body,
           row_common      = tbl_res$lg_tbl_row_common,
           table_body_head = tbl_res$lg_tbl_body_head,
           row_common_head = tbl_res$lg_tbl_row_common_head,
           max_row         = 20,
           max_col         = 10,
           notes_detect    = c("BQL", "NC"))


# Notes detected in the first table:
res[["tables"]][["Table 1"]][["notes"]]

# First table as a data frame:
res[["tables"]][["Table 1"]][["df"]]

# First table as a flextable:
res[["tables"]][["Table 1"]][["ft"]]

}