as_html: Convert an 'rtable' object to a 'shiny.tag' HTML object

In rtables: Reporting Tables

Convert an rtable object to a shiny.tag HTML object

Description

The returned HTML object can be immediately used in shiny and rmarkdown.

Usage

as_html(
  x,
  width = NULL,
  class_table = "table table-condensed table-hover",
  class_tr = NULL,
  class_th = NULL,
  link_label = NULL,
  bold = c("header"),
  header_sep_line = TRUE,
  no_spaces_between_cells = FALSE,
  expand_newlines = FALSE
)

Arguments

x	(VTableTree) a TableTree object.
width	(character) a string to indicate the desired width of the table. Common input formats include a percentage of the viewer window width (e.g. "100%") or a distance value (e.g. "300px"). Defaults to NULL.
class_table	(character) class for table tag.
class_tr	(character) class for tr tag.
class_th	(character) class for th tag.
link_label	(character) link anchor label (not including ⁠tab:⁠ prefix) for the table.
bold	(character) elements in table output that should be bold. Options are "main_title", "subtitles", "header", "row_names", "label_rows", and "content_rows" (which includes any non-label rows). Defaults to "header".
header_sep_line	(flag) whether a black line should be printed to under the table header. Defaults to TRUE.
no_spaces_between_cells	(flag) whether spaces between table cells should be collapsed. Defaults to FALSE.
expand_newlines	(flag) Defaults to FALSE, relying on html output to solve newline characters (⁠\n⁠). Doing this keeps the structure of the cells but may depend on the output device.

Value

A shiny.tag object representing x in HTML.

Examples

tbl <- rtable(
  header = LETTERS[1:3],
  format = "xx",
  rrow("r1", 1, 2, 3),
  rrow("r2", 4, 3, 2, indent = 1),
  rrow("r3", indent = 2)
)

as_html(tbl)

as_html(tbl, class_table = "table", class_tr = "row")

as_html(tbl, bold = c("header", "row_names"))

## Not run: 
Viewer(tbl)

## End(Not run)

rtables documentation built on Sept. 30, 2024, 9:32 a.m.