Report Output and Formatting
A Period Pattern 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 Period Pattern 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,feature.Area.managed.DF,feature.Area.managed.LA,feature.Area.managed.PL,feature.Area.managed.SEFA,
feature.Area.managed.SW,feature.Area.managed.SWWet,TOTAL
0,0,0,32,81,0,0,113
1,0,0,32,81,0,0,113
2,0,0,32,81,0,0,113
3,0,0,32,81,0,0,113
4,0,0,32,81,0,0,113
5,0,0,32,81,0,0,113
6,0,0,32,81,0,0,113
...
The HTML sub-report contains a well formatted table holding
similar information to the CSV sub-report. The column headings
of the HTML table are based on the unique attributes which match
the columnPrefix. Column headings are
displayed using a nested format according to the following
recipe:
Column names are sorted in alphabetical order.
The
columnPrefixis trimmed off of each attribute name.The remainder of the column name is split into words at "." characters.
Columns headings are displayed in multiple rows, one row for each split of the attribute name. Column headings are merged together where adjacent cells have the same word (see the example below).
Figure 103. Period Pattern Report HTML Table
The figure shows an example of the table
portion of the HTML report. The colour-coded areas
show columns created by
columnPrefix (GREEN), number of
defined periods (Blue),
row totals (BLUE), and cell values (Tan).
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
unique attribute. The Y-axis is automatically scaled
to fit the data, and labeled with the
units parameter. The X-axis
displays period numbers.
Figure 104. PNG Sub-Report produced by Period Pattern Report
The stacked bar chart is automatically created and embedded in the HTML document (see General Report Format).