ss_huxtable: Create summary table using huxtable package.

In oucru-biostats/C306: Collection of useful R codes for data analysis from the Biostatistics group at OUCRU

Create summary table using huxtable package.

Description

This function generate a huxtable from a sstable.

Usage

ss_huxtable(sstable, ...)

## S3 method for class 'list'
ss_huxtable(sstable, add_footer = NULL, ...)

## Default S3 method:
ss_huxtable(
  sstable,
  footer = NULL,
  caption = NULL,
  caption_pos = c("top", "bottom", "topleft", "topcenter", "topright", "bottomleft",
    "bottomcenter", "bottomright"),
  bg = c(grey(0.95), "white"),
  border_width = 0.8,
  border_color = grey(0.75),
  wrap = FALSE,
  ...
)

Arguments

sstable	a data frame following sstable's grammar
...	additional parameters that will be passed to ss_format if the sstable has yet to be formatted.
add_footer	additional footer lines to be appended to object footers
footer	a character vector each of which is the footnote of the flextable
caption	a string containing table caption. Default is NULL
caption_pos	A length-one character vector, one of "top", "bottom", "topleft", "topcenter", "topright", "bottomleft", "bottomcenter", "bottomright". Default is "bottomcenter". See also caption_pos
bg	a character vector that defines background color of the flextable. If length(bg) >= 2, the table will have stripe background, otherwise plain.
border_width	a number that defines huxtable border width
border_color	a character string that defines huxtable border color
wrap	a logical value. Default is FALSE. If TRUE, long texts would be wrapped, long lines would be broken. This applies to the whole table. Please use huxtable::set_wrap instead if you want a cell-wise approach. See also wrap

Value

an object of class huxtable

See Also

huxtable

oucru-biostats/C306 documentation built on Sept. 1, 2024, 10:04 a.m.