Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(stats): update min/max in computeStats to handle no outliers #853

Merged
merged 2 commits into from
Oct 7, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/visx-stats/src/util/computeStats.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@ export default function computeStats(numericalArray: number[]) {
const thirdQuartile = calcMedian(upperHalf);
const IQR = thirdQuartile - firstQuartile;

const min = firstQuartile - 1.5 * IQR;
const max = thirdQuartile + 1.5 * IQR;
let min = firstQuartile - 1.5 * IQR;
let max = thirdQuartile + 1.5 * IQR;

const outliers = points.filter(p => p < min || p > max);
if (outliers.length === 0) {
min = Math.min(...points);
max = Math.max(...points);
}
const binWidth = 2 * IQR * (sampleSize - outliers.length) ** (-1 / 3);
const binCount = Math.round((max - min) / binWidth);
const actualBinWidth = (max - min) / binCount;
Expand Down
16 changes: 11 additions & 5 deletions packages/visx-stats/test/computeStats.test.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
import { computeStats } from '../src';
import { computeStats } from "../src";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the addition of double quotes throughout here is failing prettier in the build. you can update them manually or run yarn format from the monorepo root.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had an issue running yarn format due to a nimbus driver not found error. Thus, I ended up doing it manually

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interesting, should work if you run yarn in the root to install all deps. in any case glad you got it!


const data = [1, 2, 3, 4, 5, 6, 6, 7, 8, 9, 1];
const edgeCaseData = [10000, 2400, 10000, 10000];

describe('computeStats', () => {
test('it should be defined', () => {
describe("computeStats", () => {
test("it should be defined", () => {
expect(computeStats).toBeDefined();
});

test('it should have boxPlot and binData', () => {
test("it should have boxPlot and binData", () => {
const stats = computeStats(data);
expect(stats.boxPlot).toBeDefined();
expect(stats.binData).toBeDefined();
});

test('it should have boxPlot and binData when first and third quartile are equal', () => {
test("it should have boxPlot and binData when first and third quartile are equal", () => {
const stats = computeStats(edgeCaseData);
expect(stats.boxPlot).toBeDefined();
expect(stats.binData).toBeDefined();
});

test("min/max should match the dataset when there are no outliers", () => {
const stats = computeStats(edgeCaseData);
expect(stats.boxPlot.min).toBe(Math.min(...edgeCaseData));
expect(stats.boxPlot.max).toBe(Math.max(...edgeCaseData));
});
});