include_md_image: Include an image file in an RMarkdown document

In alexanderbrenning/alexmisc: Alexander Brenning's Miscellaneous Functions

Description

Include an image file in an RMarkdown document

Usage

include_md_image(
  file,
  path = NULL,
  caption = NULL,
  default_caption = "",
  width = NULL,
  include_suppl = TRUE,
  fontsize = -2
)

Arguments

file, path	File name and folder of image to be included in the Markdown document. It is recommended to use here::here() to specify the path.
caption	Figure caption. If "NULL" and metadata exists, use image_caption() to construct an image caption.
default_caption	Default caption, if caption argument is NULL.
width	Image width, e.g. "5cm". If NULL (default), don't specify width in Markdown.
include_suppl	Include image file? Defaults to TRUE.
fontsize	HTML font size, relative to current standard setting. Default: -2.

Value

Markdown code to be included in the document. The function is also called for its side effect of calling exams::include_supplement().

alexanderbrenning/alexmisc documentation built on Jan. 7, 2022, 5:41 p.m.