fix(ava/insight): modify type definition & test cases

antvis · Jun 20, 2023 · 3a7c6f5 · 3a7c6f5
1 parent 52bf01c
commit 3a7c6f5
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 24 deletions.
diff --git a/packages/ava/__tests__/integration/insight/insight.test.ts b/packages/ava/__tests__/integration/insight/insight.test.ts
@@ -460,11 +460,39 @@ describe('test for distribution insight', () => {
   });
   // 异常值
   test('category outlier', async () => {
+    // 使用默认的IQR方法识别异常值
     const result = getInsights(dataWithMajorityAndOutlier, {
       insightTypes: ['category_outlier'],
       dimensions: [{ fieldName: 'product' }],
     });
     expect(result.insights).toBeIncludeInsights([
+      {
+        measures: [{ fieldName: 'yield', method: 'SUM' }],
+        dimensions: [{ fieldName: 'product' }],
+        subspace: [],
+        patterns: [
+          {
+            type: 'category_outlier',
+            significance: 0.9,
+            index: 0,
+            x: 'apple',
+            y: 160,
+          },
+        ],
+      },
+    ]);
+
+    // 指定用p-value来检测异常值
+    const pValueResult = getInsights(dataWithMajorityAndOutlier, {
+      insightTypes: ['category_outlier'],
+      dimensions: [{ fieldName: 'product' }],
+      algorithmParameter: {
+        outlier: {
+          method: 'p-value',
+        },
+      },
+    });
+    expect(pValueResult.insights).toBeIncludeInsights([
       {
         measures: [{ fieldName: 'yield', method: 'SUM' }],
         dimensions: [{ fieldName: 'product' }],

diff --git a/packages/ava/__tests__/unit/insight/extractors/category-outlier.test.ts b/packages/ava/__tests__/unit/insight/extractors/category-outlier.test.ts
@@ -37,7 +37,7 @@ const data = [
 
 describe('extract category-outlier insight', () => {
   test('check outliers result', () => {
-    const result = extractor(data, ['type'], [{ fieldName: 'sales', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['type'], measures: [{ fieldName: 'sales', method: 'SUM' }] });
     const outlierIndexes = result?.map((item) => item.index);
     expect(outlierIndexes).toStrictEqual([3]);
   });

diff --git a/packages/ava/__tests__/unit/insight/extractors/change-point.test.ts b/packages/ava/__tests__/unit/insight/extractors/change-point.test.ts
@@ -14,7 +14,7 @@ const data = [
 
 describe('extract change-point insight', () => {
   test('check change-point result', () => {
-    const result = extractor(data, ['year'], [{ fieldName: 'value', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['year'], measures: [{ fieldName: 'value', method: 'SUM' }] });
     expect(result[0]?.index).toEqual(5);
   });
 });
diff --git a/packages/ava/__tests__/unit/insight/extractors/correlation.test.ts b/packages/ava/__tests__/unit/insight/extractors/correlation.test.ts
@@ -36,14 +36,14 @@ const data = [
 
 describe('extract correlation insight', () => {
   test('check correlation result', () => {
-    const result = extractor(
+    const result = extractor({
       data,
-      [],
-      [
+      dimensions: [],
+      measures: [
         { fieldName: 'x', method: 'SUM' },
         { fieldName: 'y', method: 'SUM' },
-      ]
-    );
+      ],
+    });
     expect(result[0]?.pcorr).toBeGreaterThan(0.8);
   });
 });
diff --git a/packages/ava/__tests__/unit/insight/extractors/low-variance.test.ts b/packages/ava/__tests__/unit/insight/extractors/low-variance.test.ts
@@ -37,7 +37,7 @@ const data = [
 
 describe('extract low-variance insight', () => {
   test('check low-variance result', () => {
-    const result = extractor(data, ['type'], [{ fieldName: 'sales', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['type'], measures: [{ fieldName: 'sales', method: 'SUM' }] });
     expect(result[0]?.significance).toBeGreaterThan(0.85);
   });
 });
diff --git a/packages/ava/__tests__/unit/insight/extractors/majority.test.ts b/packages/ava/__tests__/unit/insight/extractors/majority.test.ts
@@ -37,7 +37,7 @@ const data = [
 
 describe('extract majority insight', () => {
   test('check majority result', () => {
-    const result = extractor(data, ['type'], [{ fieldName: 'sales', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['type'], measures: [{ fieldName: 'sales', method: 'SUM' }] });
     expect(result[0]?.index).toEqual(5);
   });
 });
diff --git a/packages/ava/__tests__/unit/insight/extractors/time-series-outlier.test.ts b/packages/ava/__tests__/unit/insight/extractors/time-series-outlier.test.ts
@@ -14,7 +14,7 @@ const data = [
 
 describe('extract time-series-outlier insight', () => {
   test('check outliers result', () => {
-    const result = extractor(data, ['year'], [{ fieldName: 'value', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['year'], measures: [{ fieldName: 'value', method: 'SUM' }] });
     const outliers = result?.map((item) => item.index);
     expect(outliers).toStrictEqual([7]);
   });

diff --git a/packages/ava/__tests__/unit/insight/extractors/trend.test.ts b/packages/ava/__tests__/unit/insight/extractors/trend.test.ts
@@ -14,7 +14,7 @@ const data = [
 
 describe('extract trend insight', () => {
   test('check trend result', () => {
-    const result = extractor(data, ['year'], [{ fieldName: 'value', method: 'SUM' }]);
+    const result = extractor({ data, dimensions: ['year'], measures: [{ fieldName: 'value', method: 'SUM' }] });
     expect(result[0]?.trend).toEqual('increasing');
   });
 });
diff --git a/packages/ava/src/insight/insights/extractors/categoryOutlier.ts b/packages/ava/src/insight/insights/extractors/categoryOutlier.ts
@@ -16,17 +16,13 @@ export const findOutliers = (
   values: number[],
   options?: InsightOptions
 ): { outliers: OutlierItem[]; thresholds: [number, number] } => {
-  const {
-    method,
-    iqrK,
-    confidenceInterval = SIGNIFICANCE_BENCHMARK,
-  } = options?.adjustableAlgorithmParameter?.outlier || {};
+  const { method, iqrK, confidenceInterval = SIGNIFICANCE_BENCHMARK } = options?.algorithmParameter?.outlier || {};
   const outliers: OutlierItem[] = [];
   const thresholds = [];
   const candidates = values.map((item, index) => {
     return { index, value: item };
   });
-  if (method !== 'NormalityTest') {
+  if (method !== 'p-value') {
     const IQRResult = categoryOutlier.IQR(values, { k: iqrK ?? IQR_K });
     const lowerOutlierIndexes = IQRResult.lower.indexes;
     const upperOutlierIndexes = IQRResult.upper.indexes;

diff --git a/packages/ava/src/insight/types.ts b/packages/ava/src/insight/types.ts
@@ -124,19 +124,19 @@ export type InsightExtractorProp = {
 };
 
 /** Key parameters in the algorithm for extracting insights */
-export type AdjustableAlgorithmParameter = {
+export type AlgorithmParameter = {
   /**
    * Contains both category outlier and time series outlier
    * */
   outlier?: {
     /**
-     * - IQR: Box and Whisker Plot method which is used by default. A point is considered an outlier when it lies outside of iqrK times the inter quartile range.
-     * - normalityTest: Assuming that the data follows a normal distribution, a point is considered an outlier if the probability of occurrence is less than 1-confidenceInterval.
+     * - IQR: Inter Quartile Range method which is used by default. A point is considered an outlier when it lies outside of iqrK times the inter quartile range.
+     * - p-value: Assuming that the data follows a normal distribution, a point is considered an outlier if the two-sided test p-value is less than 1-confidenceInterval.
      * */
-    method?: 'IQR' | 'NormalityTest';
-    /** Default value is 1.5. */
+    method?: 'IQR' | 'p-value';
+    /** Parameter of Inter Quartile Range method. Default value is 1.5. */
     iqrK?: number;
-    /** Default value is 0.95. */
+    /** Parameter of p-value method. Default value is 0.95. */
     confidenceInterval?: number;
   };
 };
@@ -164,7 +164,7 @@ export interface InsightOptions {
   /** Parameter passed through to the data frame during data pre-processing */
   dataProcessInfo?: Extra;
   /** Key parameters in the algorithm for extracting insights */
-  adjustableAlgorithmParameter?: AdjustableAlgorithmParameter;
+  algorithmParameter?: AlgorithmParameter;
 }
 
 export interface BasePatternInfo<T extends InsightType> {