to_word: pass tibble_one to flextable

In tibbleOne: Table One for 'Latex', 'Word', and 'Html' 'R Markdown' Documents

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("stable")}

Tabular summaries of characteristics (i.e., table one) are generally presented in a table with columns that describe the overall sample and subsets of the sample designated by a grouping variable. In addition, it is expected that variable labels and units will be indicated, and footnotes will be placed at the bottom of the table with full descriptions of variables and abbreviations that appear in the table. This function automates these tasks.

Usage

to_word(
  object,
  font_size = 11,
  use_groups = TRUE,
  indent_groups = TRUE,
  footnote_notation = "symbol",
  include_1st_header = TRUE,
  include_2nd_header = TRUE,
  include_3rd_header = TRUE
)

Arguments

object	a tibble_one object
font_size	the size of font in the table.
use_groups	T/F, should rows be grouped?
indent_groups	T/F, should entries within groups be indented? (this has no effect if use_groups is FALSE)
footnote_notation	character value indicating footnote symbols to use in tables. Eligible values are symbol, number, and alphabet.
include_1st_header	T/F, should bottom header be included?
include_2nd_header	T/F, should middle header be included?
include_3rd_header	T/F, should top header be included?

Value

a flextable.

tibbleOne documentation built on Jan. 29, 2020, 5:07 p.m.