diff --git a/src/x/xBoxPlot.ts b/src/x/xBoxPlot.ts index b6925322..630ad3e1 100644 --- a/src/x/xBoxPlot.ts +++ b/src/x/xBoxPlot.ts @@ -20,6 +20,7 @@ export interface XBoxPlot { * Calculating the box plot of the array * @param array - data * @param options + * @returns - q1, median, q3, min, max */ export function xBoxPlot( array: NumberArray, diff --git a/src/x/xBoxPlotWithOutliers.ts b/src/x/xBoxPlotWithOutliers.ts index c3cb25cd..d8dd3043 100644 --- a/src/x/xBoxPlotWithOutliers.ts +++ b/src/x/xBoxPlotWithOutliers.ts @@ -12,9 +12,11 @@ export interface XBoxPlotWithOutliers { } /** - * Calculating the box plot of the array + * Calculating the box plot of the array with outliers + * Values are outliers if they are below Q1 - 1.5 * IQR or above Q3 + 1.5 * IQR * @param array - data * @param options + * @returns - q1, median, q3, min, max, outliers */ export function xBoxPlotWithOutliers( array: NumberArray,