calc-stats - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

calc-stats.js

@@ -80,3 +80,3 @@ const fasterMedian = require("faster-median");
   let needCount = calcMean || calcMedian;
-  let needHistogram = calcMode || calcModes || calcHistogram;
+  let needHistogram = calcHistogram || calcMedian || calcMode || calcModes;
   let needSum = calcSum || calcMean;
@@ -83,0 +83,0 @@

package.json

 {
   "name": "calc-stats",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Memory-Aware Statistical Calculations",
@@ -5,0 +5,0 @@ "main": "calc-stats.js",

README.md

@@ -21,3 +21,3 @@ # calc-stats
 
-# usage
+# basic usage
 ```javascript
@@ -50,2 +50,22 @@ import calcStats from "calc-stats";
 */
-```
+```
+
+# advanced usage
+If you only care about specific statistics, you can configure calcStats through an options object:
+```js
+import calcStats from "calc-stats";
+
+// we only want the min and max
+const options = {
+  calcHistogram: false,
+  calcMax: true,
+  calcMean: false,
+  calcMedian: false,
+  calcMin: true,
+  calcMode: false,
+  calcModes: false,
+  calcSum: false
+};
+const results = calcStats(data, options);
+// results is { min: 1, max: 100 }
+```

No alert changes

Improved metrics

Total package byte prevSize

12957

increased by3.76%

Number of lines in readme file

70

increased by42.86%

No dependency changes