Generate the caption for a figure

Source: R/render_rmd.R

This function generates either a short or expanded caption for a given figure.

md_caption(
  title,
  md = here::here("modals/_captions.md"),
  get_details = F,
  fig_in_report = T
)

Arguments

title

The name of a figure.
md

The md file containing the list of captions.
get_details

A Boolean variable indicating whether a short or expanded caption is required.
fig_in_report

A Boolean variable indicating whether the figure described in the caption is present in the condition report.

Value

A string containing the caption, with html tags inserted.

Examples

if (FALSE) {
md_caption("Figure Ux.Ocean.SST.ERD.map.", get_details = T)
}