Convert a t1_summary object to a huxtable — as_huxtable.t1

Convert a t1_summary object to a huxtable

Usage

# S3 method for class 't1_summary'
as_huxtable(
  x,
  ...,
  layout = "single",
  override_percent_dp = list(),
  override_real_dp = list(),
  font_size = getOption("huxtableone.font_size", 8),
  font = getOption("huxtableone.font", "Arial"),
  footer_text = NULL,
  show_binary_value = NULL
)

Arguments

x: the t1_summary object as produced by describe_population
...: not used
layout: (optional) various layouts are defined as default. As of this version of huxtableone they are "relaxed","compact","micro","simple","single","missing". The layouts can be customised using the options options("huxtableone.format_list"=list(...)"), and this is described in more detail in the vignettes.
override_percent_dp: (optional) a named list of overrides for the default precision of formatting percentages, following a c(<colname_1> = 2, <colname_2> = 4, ...) format. columns not present in this list will use the defaults defined in the layout. See the vignette on customisation.
override_real_dp: (optional) a named list of overrides for the default precision of formatting real values, following a c(<colname_1> = 2, <colname_2> = 4, ...) format. columns not present in this list will use the defaults defined in the layout. See the utils::vignette("customisation", package="huxtableone").
font_size: (optional) the font size for the table in points
font: (optional) the font family for the table (which will be matched to closest on your system)
footer_text: any text that needs to be added at the end of the table, setting this to FALSE dsables the whole footer (as does options("huxtableone.hide_footer"=TRUE)).
show_binary_value: if set this will filter the display of covariates where the number of possibilities is exactly 2 to this value.

Value

a formatted table as a huxtable