IRIS Toolbox Reference Manual

# Report functions

#### New report

- `new` - Create new, empty report object.
- `copy` - Create a copy of a report object.

#### Compiling PDF report

- `publish` - Compile PDF from report object.

#### Top-level objects

- `table` - Start new table.
- `figure` - Start new figure.
- `userfigure` - Insert existing figure window.
- `matrix` - Insert matrix or numeric array.
- `modelfile` - Write formatted model file.
- `array` - Insert array with user data.
- `tex` - Include code or verbatim input in report.

#### Inspecting and maninpulating report objects

- `disp` - Display the structure of report object.
- `display` - Display the structure of report object.
- `findall` - Find all objects of a given type within report object.

#### Figure objects

- `graph` - Add graph to figure.

#### Table and graph objects

- `band` - Add new data with lower and upper bounds to graph or table.
- `fanchart` - Add fanchart to graph.
- `series` - Add new data to graph or table.
- `subheading` - Enter subheading in table.
- `vline` - Add vertical line to graph.
- `highlight` - Highlight range in graph.

#### Structuring reports

- `align` - Vertically align the following K objects.
- `empty` - Empty report object.
- `include` - Include text or LaTeX input file in the report.
- `merge` - Merge the content of two or more report objects.
- `pagebreak` - Force page break.
- `section` - Start new section in report.

#### Getting on-line help on report functions

    help report
    help report/function_name

#### Generic options

The following generic options can be used on any of the report objects.

- `'inputFormat='` [ *`'plain'` | `'latex'` ] - Input format for user supplied text strings (such as captions, headings, footnotes, etc); `'latex'` means they are assumed to be valid strings, and will be inserted straight into the report code with no modification.

- `'saveAs='` [ char | empty ] - (Not inheritable from parent objects) Save the LaTeX code generated for the respective report element in a text file under the specified name.

IRIS Toolbox. Copyright © 2007—2013 Jaromir Benes.