The Document tool allows you to review the equation, definition, units of measure, and selected values for a variable. This information is often required to understand why a variable functions as it does, given the inputs. The Document tool also allows you to document portions of a model, variables of particular type, or even an entire model.
Document options
In addition to the standard options, the Document tool allows you to select what information you want to see for a variable, and in what format.
First select what to display. The available options are "All variables", "Selected variables" and "Variables on the current view".
There are two display options available.
- Grid view. This is a spreadsheet like view of the variables.
- List view. This is similar to the legacy document tool.
The next set of checkboxes allow you to control what is initially viewed in the tool. The document tool is interactive so you can change these during use. For example, tick the "Units" box to make sure units are displayed when you invoke the tool for the first time.
You can sort the output alphabetically, as it is in the model, or by group.
The equation can be formatted in three ways, Original, Verbose and Terse.
Next there are a series of filters to display different variable types when launched.
Document Output - Grid view
The following image shows the grid view of the document tool. You can select entries in the grid to view the comment, causes/uses and equation(s). Clicking the view icon (
) allows you to turn on/off columns in the grid. To sort a column, simply click on the column header.
Document Output - List view
The following image shows the list view of the document tool. It works in much the same way as the grid view.
