Regression on statili

Exponential

Mon, 01 Jan 0001 00:00:00 +0000

@statili/forge ·v0.0.2-beta.0 ·2 exports

# exponentialFacts function

packages/forge/src/regression/exponential.ts:47

signature

exponentialFacts(options: ExponentialFactOptions, statsResult: RegressionResult): FactResult

Generates facts from an exponential regression result.

Emits trend.exponential — with the per-step multiplier and the doubling time or half-life — plus fit.quality, fit.error, and a small-sample caveat.

Parameters

Name	Type	Description
options	CommonFactOptions	—
statsResult	RegressionResult	—

Returns

FactResult

# ExponentialFactOptions type

packages/forge/src/regression/exponential.ts:17

signature

type ExponentialFactOptions = LogarithmicFactOptions;

Options are the shared set — exponential adds no thresholds of its own.

Linear Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# linearFacts function

packages/forge/src/regression/linear.ts:103

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.

Parameters

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

Returns

FactResult

Facts, or an end-user facing error.

Example

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

Loess

Mon, 01 Jan 0001 00:00:00 +0000

@statili/forge ·v0.0.2-beta.0 ·2 exports

# loessFacts function

packages/forge/src/regression/loess.ts:47

signature

loessFacts(options: LoessFactOptions, smoothResult: SmoothResult): FactResult

Generates facts from a LOESS smoothing result.

Emits trend.smoothed — turning points and net direction — plus fit.quality, fit.error, and a small-sample caveat.

There is no trend fact with a rate or coefficient, because a smoother fits no equation. Its contribution is shape: “rises to a peak at week 12, then declines” is a claim no parametric fit in this library can make.

Logarithmic Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# logarithmicFacts function

packages/forge/src/regression/logarithmic.ts:59

signature

logarithmicFacts(options: LogarithmicFactOptions, statsResult: RegressionResult): FactResult

Generates facts from a logarithmic regression result.

Emits trend.logarithmic, effect.diminishing where the curve rises, fit.quality, fit.error, and a small-sample caveat.

Parameters

Name	Type	Description
options	CommonFactOptions	—
statsResult	RegressionResult	—

Returns

FactResult

Logistic Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# logisticFacts function

packages/forge/src/regression/logistic.ts:85

signature

logisticFacts(options: LogisticFactOptions, statsResult: MultiRegressionResult): FactResult

Generates facts from a binary logistic regression result.

Emits model.logistic, one effect.feature per predictor (with odds multipliers), effect.boundary, fit.quality on the McFadden pseudo-R² scale, and caveats for low accuracy and small samples.

No fit.error: RMSE on a 0/1 outcome is not a meaningful error measure.

Parameters

Name	Type	Description
options	LogisticFactOptions	—
statsResult	MultiRegressionResult	—

Returns

FactResult

Multilinear Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# multilinearFacts function

packages/forge/src/regression/multilinear.ts:41

signature

multilinearFacts(options: MultilinearFactOptions, statsResult: MultiRegressionResult): FactResult

Generates facts from a multiple linear regression result.

Emits model.multilinear, one effect.feature per predictor, fit.quality, fit.error, and a small-sample caveat.

No curve annotation: with several predictors there is no single X axis to draw against.

Parameters

Name	Type	Description
options	CommonFactOptions	—
statsResult	MultiRegressionResult	—

Returns

FactResult

Polynomial Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# polynomialFacts function

packages/forge/src/regression/polynomial.ts:76

signature

polynomialFacts(options: PolynomialFactOptions, statsResult: RegressionResult): FactResult

Generates facts from a polynomial regression result.

Emits trend.polynomial (with a vertex marker for quadratics), fit.quality, fit.error, and caveats for overfitting and small samples.

Parameters

Name	Type	Description
options	PolynomialFactOptions	—
statsResult	RegressionResult	—

Returns

FactResult

Power Regression

Mon, 01 Jan 0001 00:00:00 +0000

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

# powerFacts function

packages/forge/src/regression/power.ts:63

signature

powerFacts(options: PowerFactOptions, statsResult: RegressionResult): FactResult

Generates facts from a power law regression result.

Emits trend.power (growth regime and doubling multiplier), effect.scale, fit.quality, fit.error, and a small-sample caveat.

Parameters

Name	Type	Description
options	PowerFactOptions	—
statsResult	RegressionResult	—

Returns

FactResult

Regression Error

Mon, 01 Jan 0001 00:00:00 +0000

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

# regressionError function

packages/forge/src/regression/regressionError.ts:11

signature

regressionError(errorResult: RegressionError | MultiRegressionError): FactResultError

Translates a technical failure from @statili/stats into an end-user facing explanation with a concrete next step.

A failed analysis is not a fact — nothing was measured — so it stays on the ok: false branch rather than becoming a no-finding.

Parameters

Name	Type	Description
errorResult	RegressionError \| MultiRegressionError	—

Returns

FactResultError