Skip to contents

sugar function to save flextable objects in an 'RTF' file.

Usage

save_as_rtf(..., values = NULL, path, pr_section = NULL)

Arguments

...

flextable objects, objects, possibly named. If named objects, names are used as titles.

values

a list (possibly named), each element is a flextable object. If named objects, names are used as titles. If provided, argument ... will be ignored.

path

Word file to be created

pr_section

a officer::prop_section object that can be used to define page layout such as orientation, width and height.

Value

a string containing the full name of the generated file

Examples


tf <- tempfile(fileext = ".rtf")

library(officer)
ft1 <- flextable(head(iris))
save_as_rtf(ft1, path = tf)


ft2 <- flextable(head(mtcars))
sect_properties <- prop_section(
  page_size = page_size(
    orient = "landscape",
    width = 8.3, height = 11.7
  ),
  type = "continuous",
  page_margins = page_mar(),
  header_default = block_list(
    fpar(ftext("text for default page header")),
    qflextable(data.frame(a = 1L))
  )
)
tf <- tempfile(fileext = ".rtf")
save_as_rtf(
  `iris table` = ft1, `mtcars table` = ft2,
  path = tf, pr_section = sect_properties
)