plantuml_knit_engine: Knit engine for plantuml

In rkrug/plantuml: Create UML Graphs using PlantUML Syntax

Knit engine for plantuml

Description

This function provides a knit engine for the plantuml. It has the following additional functions:

• plantuml.format: the format of the generated image. For formats which return images, these will be inserted, formats resulting in text qill be included as text. At the moment, the following are supported:

  • auto (default) uses svg if output is html and pdf if output is pdf

  • png To generate image using PNG format (default).

  • svg To generate image using SVG format.

  • eps To generate text in EPS format; or generates an image when outputting LaTeX rather than HTML formats.

• plantuml.path: the path where the resulting files will be saved. Default is the same directory as the .Rmd file is in in a directory named ' plantuml. The path will be created if it does not exist. The name of each plantuml figure is the label of thre chunk with the extension as specified.

• plantuml.preview: if TRUE, an inline preview will be shown in RStudio. Attention: the processing takse twice as long as without this option!.

Usage

plantuml_knit_engine(options)

Arguments

options

knitr options see knitr

Details

Thanks to Emiliano Heyns (retorquere) for giving me the idea for this functiion https://github.com/rkrug/plantuml/issues/10#issue-639795529 See knit_engines in the knitr packages for details

Value

See knit_engines in the knitr packages for details

Examples

## Not run: 
## see
system.file("plantuml.Rmd", package = "plantuml")
## for an example RMarkdown file usint this knit engine.

## End(Not run)

rkrug/plantuml documentation built on June 3, 2023, 6:24 a.m.