The Reports Tab

The Report Writer can be accessed from the Reports tab along the bottom left side of the main Patchworks panel. The reports are organized in a directory tree, where folders and subfolders group similar reports.

Reports are generated in either html, png, or csv depending on what they are depicting. Most of the reports in the panel can be viewed using your default web browser. Reports are generated using various tables which provide the source information. The Patchworks Report Writer provides a complete list of all reports that have been defined in the PIN file. These reports are generated using the entire source data table (i.e. all records in the block table), if, however, you are only interested in a summary of specific records, reports must be generated in the Table Viewer (see the section called “Table Viewer Reports Menu” below). The Patchworks Report Writer provides this complete listing no matter which map layers are selected, which targets are active or which individual records of various tables are selected.

To help organize reports, similar reports can be grouped into folders and sub-folders when they are defined in the PIN file. Index reports can then be defined in the PIN file to list the contents of folders. These index reports are opened in your web browser and provide 'hyperlinks' to the individual reports. Clicking on the Reports folder at the top of the directory tree will give you a navigation pane in your web browser from which all other reports are accessible.

Part of the advantage of the Report Writer is the accessibility of reports through the hierarchical directory tree. This directory is extremely flexible and can be defined when adding reports to the PIN file. When specifying the filename, a folder can be added to the parameter for grouping reports together by a common theme. For example, reports which summarize values contained within distinct areas can be grouped together by placing them in area folders. Like all directory navigation, each level of the directory is seperated by a "/", therefore a filename could read: "watershed/volumeharvested/watershed_Doug". Titles which appear in the Report Writer panel are created within an Index Report, otherwise the name specified in the filename parameter will appear.

Figure 90. Report Writer Directory Tree


There are two types of reports accessible from the reports tab. The first are the html reports illustrated by the Text icon. Clicking on any of these will bring you directly to your web browser. The csv reports are shown by the Table icon. Clicking on any of these will give you the option of opening the table in a spreadsheet program or saving the file to a folder of your choice.

[Important]The Report Writer vs. the Comparison Writer

Patchworks provides two Report Writer containers for your use. The main one is connected to the 'Reports' tab and the Save Report Wizard. This report writer is used to hold reports for the current simulation, and is referred to in the scripting examples as 'reportWriter'. The second report writer container is intended to hold comparison reports that compare the results of one scenario to another. This report writer is connected to the 'Comparisons' tab, and the 'Save Comparison Reports' menu item that is located under the Tools menu, and is referred to in the scripting examples as 'comparisonWriter'. These two report writers are identical, other than they are intended to organize two different sets of reports.