image_caption: Simple image caption from metadata

Description Usage Arguments Value

View source: R/wiki_images.R

Description

Simple image caption from metadata

Usage

1
2
3
4
5
6
7
image_caption(
  x,
  use_name = TRUE,
  use_date = FALSE,
  nchar_description = 30,
  language = c("de", "en")[1]
)

Arguments

x

Image metadata as returned by download_wiki_image(). The description field will be used to create a figure caption.

use_name

Include the author's name in figure caption? (Default: TRUE).

use_date

Include the image date in figure caption? (Default: FALSE).

nchar_description

Maximum number of characters for the description.

language

Either "de" (German caption; the current default) or "en" (English version).

Value

A single character string with an image description and basic provenance information.


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