/benfordslaw

npm Package which provides a check if a number array confirms to the Benford's Law

Primary LanguageTypeScriptMIT LicenseMIT

benfordslaw

Build Status npm version npm Coverage Branches Coverage Lines Coverage Functions Coverage Statements

Check if a number array confirms to the Benford's Law

Heavily inspired by https://github.com/target/huntlib

Install

npm i benfordslaw

Usage

Look at the tests for good examples.

E.g.:

import { BenfordsLaw } from 'benfordslaw';

const numbers = [1,2,3,4,5,6,7,8,9];
const benfords = new BenfordsLaw(numbers);

const chiSquared = benfords.getChiSquared();
// chiSquared = 0.40105320411553363
const probability = benfords.getProbability()?.toFixed(1);
// probability = 1.0

The ChiSquared result is a float and describes how well Benford's Law was matched. Lower is better.

The Probability describes how relevant ChiSquared is. It should be >= 0.9

getDist() returns the distribution of the numbers.

Why TypeScript

With Types TypeScript adds a extra layer of security. I also use mainly TypeScript projects with this project so TypeScript just makes sense. And TS also compiles to JavaScript Code so JS projects also can use it.

General Information

License: MIT

Author: Christoph Daniel Miksche

See also