tt_to_tlgrtf {junco} | R Documentation |
TableTree to .rtf Conversion
Description
A function to convert TableTree to .rtf
Usage
tt_to_tlgrtf(
tt,
file = NULL,
orientation = c("portrait", "landscape"),
colwidths = def_colwidths(tt, fontspec, col_gap = col_gap, label_width_ins =
label_width_ins, type = tlgtype),
label_width_ins = 2,
watermark = NULL,
pagenum = ifelse(tlgtype == "Listing", TRUE, FALSE),
fontspec = font_spec("Times", 9L, 1.2),
pg_width = pg_width_by_orient(orientation == "landscape"),
margins = c(0, 0, 0, 0),
paginate = tlg_type(tt) == "Table",
col_gap = ifelse(tlgtype == "Listing", 0.5, 3),
nosplitin = list(row = character(), col = character()),
verbose = FALSE,
tlgtype = tlg_type(tt),
string_map = default_str_map,
markup_df = dps_markup_df,
combined_rtf = FALSE,
one_table = TRUE,
border_mat = make_header_bordmat(obj = tt),
...
)
Arguments
tt |
TableTree object to convert to RTF |
file |
character(1). File to create, including path, but excluding .rtf extension. |
orientation |
Orientation of the output ("portrait" or "landscape") |
colwidths |
Column widths for the table |
label_width_ins |
Label width in inches |
watermark |
(optional) String containing the desired watermark for RTF outputs. Vectorized. |
pagenum |
(optional) Logical. When true page numbers are added on the right side of the footer section in the format page x/y. Vectorized. (Default = FALSE) |
fontspec |
Font specification object |
pg_width |
Page width in inches |
margins |
Margins in inches (top, right, bottom, left) |
paginate |
Whether to paginate the output |
col_gap |
Column gap in spaces |
nosplitin |
list(row=, col=). Path elements whose children should not be paginated within if it can be avoided. e.g., list(col="TRT01A") means don't split within treatment arms unless all the associated columns don't fit on a single page. |
verbose |
Whether to print verbose output |
tlgtype |
Type of the output (Table, Listing, or Figure) |
string_map |
Unicode mapping for special characters |
markup_df |
Data frame containing markup information |
combined_rtf |
logical(1). In the case where the result is broken up into multiple
parts due to width, should a combined rtf file also be created. Defaults to |
one_table |
logical(1). If |
border_mat |
matrix. A |
... |
Additional arguments passed to gentlg |
Details
This function aids in converting the rtables TableTree into the desired .rtf file.
Value
If file
is non-NULL, this is called for the side-effect of writing
one or more RTF files. Otherwise, returns a list of huxtable
objects.
Note
file
should always include path. Path will be extracted
and passed separately to gentlg
.
When one_table
is FALSE
, only the width of the row label
pseudocolumn can be directly controlled due to a limitation in
tidytlg::gentlg
. The proportion of the full page that the first value
in colwidths would take up is preserved and all other columns equally
split the remaining available width. This will cause, e.g., the
elements within the allparts rtf generated when combined_rtf
is TRUE
to differ visually from the content of the individual part rtfs.
See Also
Used in all table and listing scripts