Package {rpic}

rpic: The 'pic' Graphics Language Rendered to SVG, PNG and PDF

Description

Renders diagrams written in the 'pic' picture-drawing language (Kernighan, 1984) to SVG, PNG and PDF, using 'rpic' https://github.com/milkway/rpic-lang, a reimplementation of 'pic' in 'Rust' with no system dependencies. Includes a native circuit-element library in the spirit of 'circuit_macros', TeX math labels typeset natively, structured compile diagnostics, and a 'knitr' language engine for inline diagrams in 'R Markdown' and 'Quarto' documents.

Author(s)

Maintainer: André Leite leite@castlab.org [copyright holder]

Authors:

• André Leite leite@castlab.org [copyright holder]

Other contributors:

• The authors of the dependency Rust crates (see inst/AUTHORS for details) [copyright holder]

See Also

Useful links:

• https://milkway.github.io/rpic-r/

• https://github.com/milkway/rpic-r

• https://github.com/milkway/rpic-lang

• Report bugs at https://github.com/milkway/rpic-r/issues

knitr engine for {rpic} chunks

Description

Register with rpic_register_knitr(), then write pic code in a chunk:

```{rpic, circuits=TRUE}
A:(0,0); B:(2,0)
resistor(A,B)
```

Chunk options: circuits, texlabels, scale.

Usage

rpic_knitr_engine(options)

Arguments

Value

The chunk output produced by knitr::engine_output() (the rendered diagram as an included figure).

Compile to a JSON bundle (as a string)

Description

Returns ⁠{svg, animations, diagnostics, warnings}⁠ — warnings carries structured compiler warnings for accepted-but-ignored input (unknown attribute words, unknown animate effects), each with the same fields as the rpic_error diagnostic. On a pic error the JSON is ⁠{error, error_info}⁠ instead (no condition is raised — the error travels in-band).

Usage

rpic_manifest(src, circuits = FALSE, texlabels = FALSE)

Arguments

Value

a JSON string; parse with e.g. jsonlite::fromJSON().

Examples

rpic_manifest('box; animate last box with "pop"')

Render pic source to a PDF file

Description

Render pic source to a PDF file

Usage

rpic_pdf(src, file, circuits = FALSE, texlabels = FALSE)

Arguments

Value

the file path, invisibly.

Render pic source to a PNG file

Description

Render pic source to a PNG file

Usage

rpic_png(src, file, scale = 2, circuits = FALSE, texlabels = FALSE)

Arguments

Value

the file path, invisibly.

Register the rpic knitr engine

Description

Register the rpic knitr engine

Usage

rpic_register_knitr()

Value

No return value; called for its side effect of registering the rpic engine with knitr::knit_engines.

Render pic source to an SVG string

Description

Render pic source to an SVG string

Usage

rpic_svg(src, circuits = FALSE, texlabels = FALSE)

Arguments

Value

an SVG string.

Errors

Compile errors are raised as a classed rpic_error condition whose info field holds the structured diagnostic (message, line, col, end_col, file, kind, found, expected, hint; absent values are NA, and file names a copy include — NA means your own input). Positions are relative to your own source, even with circuits = TRUE:

tryCatch(
  rpic_svg("bxo", circuits = TRUE),
  rpic_error = function(e) e$info$hint  # "did you mean `box`?"
)

Examples

rpic_svg('box "hi"; arrow; circle "x"')
tryCatch(rpic_svg("bxo"), rpic_error = function(e) e$info$line)