image

Builtin index

What it is

No chapter describes this one yet. It exists -- the name comes from the interpreter's own table -- but the prose has not been written. That is a gap in the documentation, not in the engine.

Overloads

One call shape — this function is not overloaded.

Examples

No documentation example calls this form yet.

How it works

r.image(path, caption=, width=, label=) -- a figure float, not a bare \includegraphics. Before this existed, a report could describe a fitted model in prose and a table but had no way to put the actual plot beside them, which is most of what a real document needs a report for.

From the note above this builtin in the interpreter, where the reasoning was written down as it was built.