InputPeriodWithExtraPredictor Method

public InputPeriod WithExtraPredictor(
	string key,
	double value
)

Public Function WithExtraPredictor ( 
	key As String,
	value As Double
) As InputPeriod

Parameters

key  String

The extra-predictor key used to identify this extra predictor. Cannot be null, must match the regular expression [-_.a-zA-Z0-9]{1,60}, and cannot be "baseload", "heatingDegreeDays", or "coolingDegreeDays".

value  Double

The value of the extra predictor over the time period covered by this InputPeriod's DayRange.

Return Value

Every InputPeriod in a set of InputData must have values for the same extra-predictor keys. So, for example, if you include an "occupancy" extra-predictor figure in one InputPeriod in your InputData, you must include an "occupancy" figure in all of them.

There's some sample code showing how to use this method in the regression API docs on our website, and also there's some additional practical information on specifying and using extra predictors in the docs for our website regression tool (which itself uses the API internally).

Reference