knitFig: Easily knit a custom figure fragment

In ufs: A Collection of Utilities

Easily knit a custom figure fragment

Description

THis function was written to make it easy to knit figures with different, or dynamically generated, widths and heights (and captions) in the same chunk when working with R Markdown.

Usage

knitFig(
  plotToDraw,
  template = getOption("ufs.knitFig.template", NULL),
  figWidth = ufs::opts$get("ggSaveFigWidth"),
  figHeight = ufs::opts$get("ggSaveFigHeight"),
  figCaption = "A plot.",
  chunkName = NULL,
  returnRaw = FALSE,
  catPlot = ufs::opts$get("knitFig.catPlot"),
  ...
)

Arguments

plotToDraw	The plot to draw, e.g. a ggplot plot.
template	A character value with the knit_expand template to use.
figWidth	The width to set for the figure (in inches).
figHeight	The height to set for the figure (in inches).
figCaption	The caption to set for the figure.
chunkName	Optionally, the name for the chunk. To avoid problems because multiple chunks have the name "unnamed-chunk-1", if no chunk name is provided, digest::digest() is used to generate an MD5-hash from Sys.time.
returnRaw	Whether to cat() the result (TRUE) or whether to return it as knitr::asis_output() object (FALSE).
catPlot	Whether to use the base::cat() function to print the code for the plot, and return the result invisibly. If not, the result is returned visible, and so probably printed anyway.
...	Any additional arguments are passed on to knit_expand.

Value

This function returns nothing, but uses knit_expand and knit to cat the result.

Author(s)

Gjalt-Jorn Peters

Maintainer: Gjalt-Jorn Peters [e-mail]

See Also

knit_expand and knit

Examples

## Not run: knitFig(ggBoxplot(mtcars, 'mpg'))

ufs documentation built on May 29, 2024, 10:30 a.m.