Click or drag to resize

RegressionSpecWithExtraPredictorKeys(IEnumerableString) Method

Returns a new RegressionSpec based on this but also specifying that extra predictors with the specified keys are to be included.

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
public RegressionSpec WithExtraPredictorKeys(
	IEnumerable<string> keys
)

Parameters

keys  IEnumerableString
The extra-predictor keys that identify the extra predictors to be included in the regression. There can be a maximum of 2 keys. Each key must match the regular expression [-_.a-zA-Z0-9]{1,60}, with "baseload", "heatingDegreeDays", and "coolingDegreeDays" specifically disallowed.

Return Value

RegressionSpec
Exceptions
ExceptionCondition
ArgumentNullExceptionkeys is null or contains null.
ArgumentExceptionThere are more than 2 keys, or any of the keys do not match the specification detailed above.
Remarks

Although the string keys contained within keys will be stored inside the returned RegressionSpec object, the IEnumerable itself will neither be stored nor modified. So you can continue using keys without concern for side effects.

See Also