Report Output and Formatting

A Patch Report will automatically generate three formats: HTML, PNG, and CSV. Each of these sub-reports contains the same data, however it is formatted appropriately for the ouput style. It is important that NO file extension is included when defining the filename parameter since the ".html", ".png" and ".csv" files are automatically created. All three files will appear in the scenario folder when the current scenario is saved. The default report provided by the Report Writer is the HTML, however this format provides links to the other two formats. The layout of the Patch Report follows the General Report Layout.

The CSV sub-report contains comma separated text values which can be read into a text editor or spreadsheet application. This sub-report contains the simplest formatting, with the first row containing the column headings and subsequent rows containing values for each period. The first column in the table contains the period number, with a column heading of 'PERIOD'. Subsequent columns contain the unique attribute names sorted in alphabetical order, and the final column contains row totals with a column heading of 'TOTAL'. The following shows a sample of a CSV format file:

	PERIOD,YEAR,PERIODWIDTH,0_100.size,100_400.size,400_800.size,800_1600.size,1600_9999999.size,
	TOTAL.size,0_100.frequency,100_400.frequency,400_800.frequency,800_1600.frequency,
	1600_9999999.frequency,TOTAL.frequency
	0,0,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	1,5,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	2,10,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	3,15,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	4,20,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	5,25,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	6,30,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	7,35,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	8,40,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	9,45,5,83,0.0,0.0,955,2688,3727,27,0,0,1,1,29.0
	...
      

The HTML sub-report contains a well formatted table holding similar information to the CSV sub-report. There are two types of information in the Patch Report. The first half of the table holds information about the area of each size class, i.e. the amount of area of all the patches within that size class, and the second half holds information on the frequency of each size class i.e. the number of patches within the size class. The column headings of the HTML table contain the size classes defined in the RangeLabel.

Figure 112. Patch Report HTML Table

The figure shows an example of the table portion of the HTML report.


Besides the table, the HTML report also contains a title, the name of the scenario, an embedded PNG version of the information, optional HTML data, a link to CSV sub-report and a link to an Index Report.

The PNG sub-report shows a stacked-bar chart with one bar for each period specified, and one stack for each patch size class. The Y-axis is automatically scaled to fit the data, and labeled with the units parameter. The X-axis displays period numbers.

Figure 113. PNG Sub-Report produced by Patch Report

The stacked bar chart is automatically created and embedded in the HTML document (see General Report Format).