Documentation

Linear Regression

@statili/forge ·v0.0.2-beta.0 ·1 export

# linearFacts function

      signature
      
linearFacts(options: LinearFactOptions, statsResult: RegressionResult): FactResult

Generates facts from a simple linear regression result.

Emits trend.linear, fit.quality, fit.error, and — where the sample supports it — fit.significance and a caveat.small-sample.

Name	Type	Description
options	LinearFactOptions	Thresholds controlling the qualitative judgements.
statsResult	RegressionResult	The raw result from `@statili/stats` `linear()`.

FactResult

Facts, or an end-user facing error.

const result = linearFacts({}, linear({}, data));
if (result.ok) result.facts.map(render({ labels: { x: "month", y: "sales" } }));