flextable (version 0.6.3)

set_caption: Set Caption

Description

Set caption value in a flextable.

• The caption will be associated with a paragraph style when the output is Word. Also it can be numbered as a auto-numbered Word computed value.

• In HTML and PDF, the style of the caption is managed at the document level and not with flextable.

• The PowerPoint format ignores captions.

Usage

set_caption(
  x,
  caption,
  autonum = NULL,
  style = "Table Caption",
  html_escape = TRUE
)

Arguments

x

flextable object

caption

caption value

autonum

an autonum representation. See officer::run_autonum(). This has only an effect when output is Word. If used, the caption is preceded by an auto-number sequence. In this case, the caption is preceded by an auto-number sequence that can be cross referenced.

style

caption paragraph style name. These names are available with function officer::styles_info() when output is Word; if HTML, the value is set as class value in the caption tag.

html_escape

should HTML entities be escaped so that it can be safely included as text or an attribute value within an HTML document.

See Also

flextable()

Examples

# NOT RUN {
ftab <- flextable( head( iris ) )
ftab <- set_caption(ftab, "my caption")
ftab

library(officer)
autonum <- run_autonum(seq_id = "tab", bkm = "mtcars")
ftab <- flextable( head( mtcars ) )
ftab <- set_caption(ftab, caption = "mtcars data", autonum = autonum)
ftab
# }