export_as_docx {rtables.officer} | R Documentation |
Export to a Word document
Description
From an rtables
table, produce a self-contained Word document or attach it to a template Word
file (template_file
). This function is based on the tt_to_flextable()
transformer and
the officer
package.
Usage
export_as_docx(
tt,
file,
add_page_break = FALSE,
titles_as_header = TRUE,
integrate_footers = TRUE,
section_properties = section_properties_default(),
doc_metadata = NULL,
template_file = NULL,
...
)
section_properties_default(
page_size = c("letter", "A4"),
orientation = c("portrait", "landscape")
)
margins_potrait()
margins_landscape()
Arguments
tt |
( |
file |
( |
add_page_break |
( |
titles_as_header |
( |
integrate_footers |
( |
section_properties |
( |
doc_metadata |
( |
template_file |
( |
... |
( |
page_size |
( |
orientation |
( |
Details
Pagination Behavior for Titles and Footers (this behavior is experimental at the moment):
The rendering of titles and footers interacts with table pagination as follows:
-
Titles: When
titles_as_header = TRUE
(default), the integrated title header rows typically repeat at the top of each new page if the table spans multiple pages. Settingtitles_as_header = FALSE
renders titles as a separate paragraph only once before the table begins. -
Footers: Regardless of the
integrate_footers
setting, footers appear only once. Integrated footnotes (integrate_footers = TRUE
) appear at the very end of the complete table, and separate text paragraphs (integrate_footers = FALSE
) appear after the complete table. Footers do not repeat on each page.
Value
No return value, called for side effects
Functions
-
section_properties_default()
: Helper function that defines standard portrait properties for tables. -
margins_potrait()
: Helper function that defines standard portrait margins for tables. -
margins_landscape()
: Helper function that defines standard landscape margins for tables.
Note
export_as_docx()
has few customization options available. If you require specific formats and details,
we suggest that you use tt_to_flextable()
prior to export_as_docx()
. If the table is modified first using
tt_to_flextable()
, the titles_as_header
and integrate_footers
parameters must be re-specified.
See Also
Examples
lyt <- basic_table() %>%
split_cols_by("ARM") %>%
analyze(c("AGE", "BMRKR2", "COUNTRY"))
tbl <- build_table(lyt, ex_adsl)
# See how the section_properties_portrait() function is built for customization
tf <- tempfile(fileext = ".docx")
export_as_docx(tbl,
file = tf,
section_properties = section_properties_default(orientation = "landscape")
)