Bug fix/deal with indicators over 9 (#22)

* proper checks for indicator length
based on elements rather than string length

Author: Tom Pearson

data/inclusiveinternet/2022/entities.csv

@@ -2,16 +2,18 @@ import {csvParse} from 'd3';
 import fs from 'fs';
 import indexCore from './src/index-core.js';
 
-const simpleRootDir = 'data/simple-index-set';
+const iiiRoot = 'data/inclusiveinternet/2022';
 
-const simpleIndicators = csvParse(fs.readFileSync(`${simpleRootDir}/indicators.csv`, 'utf-8'));
-const simpleEntities = csvParse(fs.readFileSync(`${simpleRootDir}/entities.csv`, 'utf-8'));
+const iiiIndicators = csvParse(fs.readFileSync(`${iiiRoot}/indicators.csv`, 'utf-8'));
+const iiiEntities = csvParse(fs.readFileSync(`${iiiRoot}/entities.csv`, 'utf-8'));
 
-const simpleIndex = indexCore(simpleIndicators, simpleEntities, 100 ,true, true);
-const simpleIndexUnrestricted = indexCore(simpleIndicators, simpleEntities);
+const iii = indexCore(iiiIndicators, iiiEntities, 100 ,true, true);
+// const iiiComparison = indexCore(iiiIndicators, iiiEntities, 100, false);
 
 //console.log( simpleIndex.getEntity('Chinatown') )
-console.log( simpleIndex.getEntity('Chinatown').value, 'vs', simpleIndexUnrestricted.getEntity('Chinatown').value );
-console.log( simpleIndex.getEntity('Chinatown')['1'], 'vs', simpleIndexUnrestricted.getEntity('Chinatown')['1'] )
-console.log( simpleIndex.getEntity('Chinatown')['1.4'], 'vs', simpleIndexUnrestricted.getEntity('Chinatown')['1.4'] )
+// console.log( simpleIndex.getEntity('Chinatown').value, 'vs', simpleIndexUnrestricted.getEntity('Chinatown').value );
+// console.log( simpleIndex.getEntity('Chinatown')['1'], 'vs', simpleIndexUnrestricted.getEntity('Chinatown')['1'] )
+// console.log( simpleIndex.getEntity('Chinatown')['1.4'], 'vs', simpleIndexUnrestricted.getEntity('Chinatown')['1.4'] )
 
+console.log('i', iii.getEntityIndicator('Algeria', '1.1'));
+console.log('i', iii.getEntityIndicator('Algeria', '1'));

data/inclusiveinternet/2022/indicators.csv

@@ -1,6 +1,6 @@
 {
   "name": "@economist/index-core",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "",
   "main": "src/index-core.js",
   "type": "module",

index.js

@@ -70,7 +70,7 @@ function indexCore(
 
   // format an indicator for passing to the weighted mean function
   function formatIndicator(indicator, entity, max) {
-    const diverging = !!indicator.diverging;
+    const diverging = (indicator.diverging === true || String(indicator.diverging).toLocaleLowerCase() === 'true');
     let value = entity.user && entity.user[indicator.id]
       ? Number(entity.user[indicator.id])
       : Number(entity[indicator.id]);
@@ -87,7 +87,7 @@ function indexCore(
       if (indicator.max) {
         range = [0, indicator.max];
         if (indicator.min) {
-          range = [0, Math.max(Math.abs(indicator.min), indicator.max)];
+          range = [0, Math.max(Math.abs(indicator.min), Math.abs(indicator.max))];
         }
       } else {
         range = [0, max];
@@ -108,22 +108,23 @@ function indexCore(
 
   function indexEntity(entity, calculationList, overwrite = allowOverwrite) {
     const newEntity = clone(entity);
-    calculationList.forEach((indicatorID) => {
-      if ((newEntity[indicatorID] && overwrite === true) || !newEntity[indicatorID]) {
+    calculationList.forEach((parentIndicatorID) => {
+      if ((newEntity[parentIndicatorID] && overwrite === true) || !newEntity[parentIndicatorID]) {
         // get the required component indicators to calculate the parent value
         // this is a bit brittle maybe?
 
         const componentIndicators = indicatorsData
-          .filter((indicator) => (indicator.id.indexOf(indicatorID) === 0
-            && indicator.id.length === indicatorID.length + 2))
+          .filter((indicator) => (
+            indicator.id.indexOf(parentIndicatorID) === 0 // the
+            && indicator.id.split('.').length === parentIndicatorID.split('.').length + 1))
           .filter((indicator) => excludeIndicator(indicator) === false)
           .map((indicator) => formatIndicator(indicator, newEntity, indexMax));
         // calculate the weighted mean of the component indicators on the newEntity
         // assign that value to the newEntity
-        newEntity[indicatorID] = calculateWeightedMean(componentIndicators, indexMax, clamp);
+        newEntity[parentIndicatorID] = calculateWeightedMean(componentIndicators, indexMax, clamp);
       } else {
-        console.warn(`retaining existing value for ${newEntity.name} - ${indicatorID} : ${Number(entity[indicatorID])}`);
-        newEntity[indicatorID] = Number(entity[indicatorID]);
+        console.warn(`retaining existing value for ${newEntity.name} - ${parentIndicatorID} : ${Number(entity[parentIndicatorID])}`);
+        newEntity[parentIndicatorID] = Number(entity[parentIndicatorID]);
       }
     });
 

package.json

@@ -23,7 +23,6 @@ export function calculateWeightedMean(weightedValues, normaliseTo = 100, clamp =
     const weightedValue = indicator.invert
       ? ((normaliseTo - normalisedValue) * indicator.weight)
       : (normalisedValue * indicator.weight);
-
     weightedSum += weightedValue;
     cumulativeWeight += indicator.weight;
   }