EMK:Output Specs - Revision history

WoodsM: /* Output Specification Partitions */

2019-07-04T04:04:16Z

Output Specification Partitions

2019-07-04T04:03:55Z

Output Specification Partitions

2019-07-02T23:42:59Z

Prefilter

2019-07-02T23:40:03Z

The Output Specs Details Box

2019-07-02T23:39:41Z

Prefilter

2019-07-02T23:38:31Z

The Output Specs Details Box

2013-08-20T22:20:31Z

2013-08-20T22:19:47Z

2013-08-20T21:19:11Z

2013-08-20T21:02:03Z

Output Specification Partitions

@@ Line 169: / Line 169: @@
 *Month - A division for each month in the forecast
 *Year - A division for each year in the forecast
-*Year(MMM) - A division for each year in the forecast, where the year is deemed to start at the given month.  For example: 'Year(Apr):All'  will create divisions based on 1 Aoril - 31 March years
+*Year(<MMM>) - A division for each year in the forecast, where the year is deemed to start at the given month.  For example: 'Year(Apr):All'  will create divisions based on 1 Aoril - 31 March years
 *Date - A division by user entered dates.  For example 'Date:1 Apr 2015, 1 Nov 2015, 1 Jan 2016' will create four divisions separated by the three dates specified

@@ Line 169: / Line 169: @@
 *Month - A division for each month in the forecast
 *Year - A division for each year in the forecast
 *Date - A division by user entered dates.  For example 'Date:1 Apr 2015, 1 Nov 2015, 1 Jan 2016' will create four divisions separated by the three dates specified

@@ Line 39: / Line 39: @@
 E.g. Version:InflowYear=1947,1980,2005-2010
-This restricts the data being processed to versions where the volatility value is in the list of values given.  The list of values are specified in the same way as they are in the volatility matrix.
+This restricts the data being processed to versions where the volatility value is in the list of values given.  The list of values are specified in the same way as they are in the '''''[[EMK:Run Window#Volatility Matrix|Volatility Matrix]]'''''.
 ==Formatting Check Boxes==

@@ Line 21: / Line 21: @@
 | ''Prefilters'' || Defines a Prefilter that restricts the results being used to generate the report. (''described below'')
 |}
 ===Prefilter===

@@ Line 25: / Line 25: @@
 ===Prefilter===
 There are two types of prefilter available: a date range prefilter, and version prefilters.  You can run more than one prefilter by separating each specification with a semi-colon.
 '''Date Prefilter'''
 Format: Date:<date from>-<date to> (dates in d MMM yyyy format)
 E.g. Date:1 Mar 2030 - 1 Mar 2035
 This restricts the data being processed to the date range given
 '''Version Prefilter'''
 Format: Version:<volatility variable name>=<values list>
 E.g. Version:InflowYear=1947,1980,2005-2010
-Specifies a date range that the OS will only process data for - this allows the OS to be used on multiple Results sets covering disparate date ranges and only extract results for a common period. The Prefilter variable is defined in the Resource/System Definition.
+This restricts the data being processed to versions where the volatility value is in the list of values given.  The list of values are specified in the same way as they are in the volatility matrix.
 ==Formatting Check Boxes==

@@ Line 12: / Line 12: @@
 ==The Output Specs Details Box==
-'''OS Details Box Fields'''
+'''Output Spec Details Box Fields'''
 {|class="wikitable"
 |-
-| ''Name'' || OS Resource name - used to reference the OS in other Resources.
+| ''Name'' || Output Spec Resource name - used to reference the OS in other Resources.
 |-
 | ''Description'' || Free text field for supplementary information.'
 |-
-| ''Prefilters'' || Specifies a date range that the OS will only process data for - this allows the OS to be used on multiple Results sets covering disparate date ranges and only extract results for a common period. The Prefilter variable is defined in the Resource/System Definition.
+| ''Prefilters'' || Defines a Prefilter that restricts the results being used to generate the report. (''described below'')
 |}
 ==Formatting Check Boxes==

@@ Line 1: / Line 1: @@
 {{#hidens:}}
 [[File:Output_Specs_Window.jpg|300px|thumb|right|Example OutputSpec Window]]
-An Output Specification (OS) Resource allows you to define customised reports to be generated from run output data. Reports generated using OS Resources are text based in a comma separated (CSV) form and the resulting files can be opened in Excel or a number of other editors. OS reports can be run as part of a '''''[[EMK:Report Batch|Report Batch]]''''' and automatically generated on the completion of the run, or they may be generated at any time from run results. Any element shown in the results window can be exported via the Output Spec.
+An Output Specification (OS) Resource allows you to define customised reports to be generated from run output data. Reports generated using OS Resources are text based in a comma separated (CSV) form and the resulting files can be opened in Excel or a number of other editors. OS reports can be run as part of a '''''[[EMK:Reports|Report Batch]]''''' and automatically generated on the completion of the run, or they may be generated at any time from run results. Any element shown in the results window can be exported via the Output Spec.
 The Output Specs window has the following components:

@@ Line 106: / Line 106: @@
 *Last() - The last (latest) value in a sample.
 *Count() - The number of values in a sample.
-*Percentile.<n>() - The nth percentile of values in the sample. '''Warning''' this function may use a lot of memory and should be used with care, especially for large forecasts.
+*Percentile.<n>() - The nth percentile of values in the sample. '''Warning''': this function may use a lot of memory and should be used with care, especially for large forecasts.
 The First and Last functions would typically be used to get the earliest and latest (in modelled time) value in a sample.  These functions do not have as much meaning if there are multiple records for each time period, i.e. if the Version or the Entity partition is not applied.  For example if you were to use the Last(Generator.Generation) function over all generators then only the latest generation for the last generator (alphabetically) would be returned.