md_caption: Generate the caption for a figure

In marinebon/infographiqR: Supporting R functions for creating intelligent interactive infographics, ie infographiq

Description

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

Usage

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

## Not run: 
md_caption("Figure Ux.Ocean.SST.ERD.map.", get_details = T)

## End(Not run)

marinebon/infographiqR documentation built on Dec. 21, 2021, 2:44 p.m.