Generate Markdown Syntax for Graphics

Creates the Markdown syntax required to display a graphics file in an RMarkdown document. Can optionally include caption and description text.

Usage

showGraphics(
  ident,
  from = pwd(),
  addAsLink = TRUE,
  caption = "",
  description = "",
  includeCaption = T,
  includeDescription = T
)

ident: Path, resource ID, or entity ID of the graphics file. Can be a relative path (from current step), absolute path, or improve identifier
from: Root path for resolving relative paths. Defaults to pwd() (current step location)
addAsLink: Logical. If TRUE, creates a link in the inventory for provenance tracking. Use improveClean() at workflow end to clean up links
caption: Custom caption text. If empty, defaults to entityID and lastModified timestamp. To suppress caption, set includeCaption = FALSE
description: Custom description text. If empty, defaults to filename. To suppress description, set includeDescription = FALSE
includeCaption: Logical. If TRUE (default), includes the caption in the generated Markdown
includeDescription: Logical. If TRUE (default), includes the description in the generated Markdown (as title text)

A character string containing the formatted Markdown syntax: ![caption](path 'description') Returns empty string if file not found.

ics1141