feature(geomean): added geomean function + upkeep

Author: prabhathc

src/lib/index.js

@@ -114,6 +114,7 @@ var statsModule = require('./stats');
 lib.aggNums = statsModule.aggNums;
 lib.len = statsModule.len;
 lib.mean = statsModule.mean;
+lib.geoMean = statsModule.geoMean;
 lib.median = statsModule.median;
 lib.midRange = statsModule.midRange;
 lib.variance = statsModule.variance;

src/lib/stats.js

@@ -47,6 +47,11 @@ exports.mean = function(data, len) {
     return exports.aggNums(function(a, b) { return a + b; }, 0, data) / len;
 };
 
+exports.geoMean = function(data, len) {
+    if(!len) len = exports.len(data);
+    return exports.aggNums(function(a, b) { return a * b; }, 0, data) ** (1 / len);
+}
+
 exports.midRange = function(numArr) {
     if(numArr === undefined || numArr.length === 0) return undefined;
     return (exports.aggNums(Math.max, null, numArr) + exports.aggNums(Math.min, null, numArr)) / 2;

src/plots/cartesian/layout_attributes.js

@@ -1012,6 +1012,7 @@ module.exports = {
             'max ascending', 'max descending',
             'sum ascending', 'sum descending',
             'mean ascending', 'mean descending',
+            'geomean ascending', 'geomean descending',
             'median ascending', 'median descending'
         ],
         dflt: 'trace',
@@ -1026,7 +1027,7 @@ module.exports = {
             'the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.',
             'Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the',
             'numerical order of the values.',
-            'Similarly, the order can be determined by the min, max, sum, mean or median of all the values.'
+            'Similarly, the order can be determined by the min, max, sum, mean, geomean or median of all the values.'
         ].join(' ')
     },
     categoryarray: {

src/plots/plots.js

@@ -3127,6 +3127,7 @@ function sortAxisCategoriesByValue(axList, gd) {
         'sum': function(values) {return Lib.aggNums(function(a, b) { return a + b;}, null, values);},
         'total': function(values) {return Lib.aggNums(function(a, b) { return a + b;}, null, values);},
         'mean': function(values) {return Lib.mean(values);},
+        'geomean': function(values) {return Lib.geoMean(values)},
         'median': function(values) {return Lib.median(values);}
     };