body_add_caption: Add Word caption in a 'Word' document

In officer: Manipulation of Microsoft Word and PowerPoint Documents

Add Word caption in a 'Word' document

Description

Add a Word caption into an rdocx object.

Usage

body_add_caption(x, value, pos = "after")

Arguments

x	an rdocx object
value	an object returned by block_caption()
pos	where to add the new element relative to the cursor, one of "after", "before", "on".

See Also

Other functions for adding content: body_add_blocks(), body_add_break(), body_add_docx(), body_add_fpar(), body_add_gg(), body_add_img(), body_add_par(), body_add_plot(), body_add_table(), body_add_toc(), body_append_start_context(), body_import_docx()

Examples

doc <- read_docx()

if (capabilities(what = "png")) {
  doc <- body_add_plot(doc,
    value = plot_instr(
      code = {
        barplot(1:5, col = 2:6)
      }
    ),
    style = "centered"
  )
}
run_num <- run_autonum(
  seq_id = "fig", pre_label = "Figure ",
  bkm = "barplot"
)
caption <- block_caption("a barplot",
  style = "Normal",
  autonum = run_num
)
doc <- body_add_caption(doc, caption)
print(doc, target = tempfile(fileext = ".docx"))

officer documentation built on Sept. 9, 2025, 5:30 p.m.