Click or drag to resize

RegressionTestPlanBuilderSetExtraPredictorSpecs Method

Sets the specifications for the extra predictors included in the InputData sent to the API, to help the API test and rank the regressions that include data for those extra predictors.

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
Copy
public RegressionTestPlanBuilder SetExtraPredictorSpecs(
	IDictionary<string, ExtraPredictorSpec> extraPredictorSpecs
)

Parameters

extraPredictorSpecs  IDictionaryString, ExtraPredictorSpec
An IDictionary with extra-predictor keys as dictionary keys (these should match the extra-predictor keys used in each InputPeriod of your InputData), and the corresponding ExtraPredictorSpec objects as values. Cannot be null or contain null, cannot have more than 2 key/value pairs, and must have valid keys matching the regular expression [-_.a-zA-Z0-9]{1,60}, with "baseload", "heatingDegreeDays", and "coolingDegreeDays" specifically disallowed.

Return Value

RegressionTestPlanBuilder
This Builder, for easy method chaining.
Exceptions
ExceptionCondition
ArgumentNullExceptionextraPredictorSpecs is null or contains null.
ArgumentExceptionThere are more than 2 key/value pairs, or if any of the keys do not match the specification detailed above.
Remarks

There's some sample code 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).

Data will be copied from the IDictionary passed in (rather than this Builder storing the IDictionary internally), so you can continue to use the IDictionary however you like after calling this method.

See Also