MATLAB Report Generator

Key Features

  • Enables push-button documentation from MATLAB
  • Documents MATLAB functions and scripts and their outputs as they are executed
  • Lets you create and distribute documentation templates
  • Provides extensible components and style sheets
  • Creates reports in multiple documentation formats, including HTML, PDF, RTF, Microsoft Word, and XML
  • Enables conditional documentation generation via logical template components, such as IF, THEN, ELSE, and WHILE

The MATLAB Report Generator facilitates information exchange and helps keep your documentation and specifications up to date with your workflow. You can also use it to create user manuals that accurately capture your application capabilities and specifications.

From the Report Generator app, you can create and edit templates, view components and templates, and change the properties of the components or report.
From the Report Generator app, you can create and edit templates (left pane), view components and templates (center pane), and change the properties of the components or report (right pane).

Working with the MATLAB Report Generator

You can control the MATLAB Report Generator through the app or from the MATLAB command line. You select what you want to document from MATLAB using a setup file, a template that lists in outline form all the components that will be included in your report. Each component specifies an action to be taken in the report, such as evaluating MATLAB code, creating a table of data variables, or capturing a figure window.

Running MATLAB Commands Within a Report

The MATLAB Report Generator enables you to evaluate MATLAB code and then capture and document the results. You can create and capture snapshots of plots and other graphics. You can also create tables of your variables or of object properties.

Creating and Editing Setup Files and Style Sheets in the Report Explorer

The MATLAB Report Generator lets you control the design, formatting, and presentation of your documentation or reports by selecting from the many built-in setup files or creating your own. You can drag and drop components from the component list into your setup file, change the order of the components, and modify component attributes and formatting. The formatting is controlled via a style sheet. You can use several built-in style sheets for each document type or create your own style sheet. You control page layout, font use, table display, header content, tables of contents, title presentation, and more. Setup files and style sheets can be reused and distributed.

From the Report Explorer GUI, you can create and edit templates, view components and templates (center pane), and change the properties of the components or report.
To generate a report you select a new or existing setup file, add components to the setup file, edit component properties, select one of the available formats, and choose a style sheet.

Creating Custom Components

The Component Creator lets you write new or update existing custom components. The component API is fully documented, enabling complete control over run-time and edit-time behavior.

Generating Documents from Your Setup Files

Once you have selected a setup file, you can generate a report in the Report Explorer or from the MATLAB command line. You can generate reports in HTML, PDF, RTF, Microsoft Word, and XML formats.

Creating Conditional Reports

The logical and flow-control components in the MATLAB Report Generator let you create conditional reports based on the data generated during the report. For example, you can run a script to analyze your data and, if a threshold value is reached, document the results. Alternatively, you can automatically run a new script for additional analysis and then capture the results.

Try MATLAB Report Generator

Get trial software

Integrating MATLAB Based Financial Analytics into Databases, Web, and Messaging Systems

View webinar