officer (version 0.3.8)

block_caption: caption block

Description

Create a representation of a caption that can be used for cross reference. The caption can also be an auto numbered paragraph.

Usage

block_caption(label, style, id, autonum = NULL)

Arguments

label

a scalar character representing label to display

style

paragraph style name

id

cross reference identifier

autonum

an object generated with function run_autonum

See Also

Other block functions for reporting: block_list(), block_section(), block_table(), block_toc(), fpar(), plot_instr(), unordered_list()

Examples

# NOT RUN {
library(magrittr)
library(officer)

run_num <- run_autonum(seq_id = "tab", pre_label = "tab. ")
caption <- block_caption("iris table",
                         style = "Normal", id = "iris_table",
                         autonum = run_num )

doc <- read_docx() %>%
  body_add("A title", style = "heading 1") %>%
  body_add("Hello world!", style = "Normal") %>%
  body_add(caption) %>%
  body_add(iris, style = "table_template")

print(doc, target = tempfile(fileext = ".docx") )
# }