@dra2020/district-analytics 1.0.4 → 1.0.7

package/lib/utils.js

@@ -0,0 +1,223 @@
+"use strict";
+//
+// UTILITIES
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+const S = require("./settings");
+// PLAN HELPERS
+// Is a "neighbor" in state?
+function isInState(geoID) {
+    return geoID != S.OUT_OF_STATE;
+}
+exports.isInState = isInState;
+// Is a "neighbor" out of state?
+function isOutOfState(geoID) {
+    return geoID == S.OUT_OF_STATE;
+}
+exports.isOutOfState = isOutOfState;
+// Get the districtID to which a geoID is assigned
+function getDistrict(plan, geoID) {
+    // All geoIDs in a state *should be* assigned to a district (including the
+    // dummy "unassigned" district), but "water-only" features are sometimes missing
+    // from a map. This is also a guard against a bug in which a geoID has no district.
+    if (keyExists(geoID, plan)) {
+        return plan[geoID];
+    }
+    else {
+        return undefined;
+    }
+}
+exports.getDistrict = getDistrict;
+// Invert a feature assignment structure to sets of ids by district
+// NOTE - This is here vs. _data.ts, so it can also be used in cli.ts
+function invertPlan(plan) {
+    let invertedPlan = {};
+    // Add a dummy 'unassigned' district
+    invertedPlan[S.NOT_ASSIGNED] = new Set();
+    for (let geoID in plan) {
+        let districtID = plan[geoID];
+        // Make sure the set for the districtID exists
+        if (!(objectContains(invertedPlan, districtID))) {
+            invertedPlan[districtID] = new Set();
+        }
+        // Add the geoID to the districtID's set
+        invertedPlan[districtID].add(geoID);
+    }
+    return invertedPlan;
+}
+exports.invertPlan = invertPlan;
+// WORKING WITH GEOIDS
+function parseGeoID(geoID) {
+    let parts = {};
+    parts['state'] = geoID.substring(0, 2);
+    parts['county'] = geoID.substring(0, 5);
+    let l = geoID.length;
+    if (l >= 11) {
+        parts['tract'] = geoID.substring(0, 11);
+    }
+    if (l >= 12) {
+        parts['bg'] = geoID.substring(0, 12);
+    }
+    if (l == 15) {
+        parts['block'] = geoID;
+    }
+    return parts;
+}
+exports.parseGeoID = parseGeoID;
+function getFIPSFromCountyGeoID(geoID) {
+    return geoID.substring(2, 5);
+}
+exports.getFIPSFromCountyGeoID = getFIPSFromCountyGeoID;
+// NORMALIZING RESULTS
+// Convert a raw score [0-1] into a normalized score [0-100]
+function normalize(rawScore, scale, invertp = false) {
+    // Invert the axis if necessary to make bigger = better
+    if (invertp) {
+        rawScore = 1.0 - rawScore;
+    }
+    // Coerce the value to be w/in the given range
+    let rangeMin = scale[0];
+    let rangeMax = scale[1];
+    let coercedValue = Math.min(Math.max(rawScore, rangeMin), rangeMax);
+    // Scale the bounded value w/in the range [0 - (rangeMax - rangeMin)]
+    let scaledValue = (coercedValue - rangeMin) / (rangeMax - rangeMin);
+    // Finally, make the range [0-100]
+    return Math.round(scaledValue * S.NORMALIZED_RANGE);
+}
+exports.normalize = normalize;
+// Round a fractional number [0-1] to the desired level of PRECISION.
+function trim(fullFraction) {
+    let shiftPlaces = Math.pow(10, S.PRECISION);
+    return Math.round(fullFraction * shiftPlaces) / shiftPlaces;
+}
+exports.trim = trim;
+// ARRAY HELPERS
+function sumArray(arr) {
+    return arr.reduce((a, b) => a + b, 0);
+}
+exports.sumArray = sumArray;
+function avgArray(arr) {
+    return (arr.reduce((a, b) => a + b, 0)) / arr.length;
+}
+exports.avgArray = avgArray;
+function minArray(arr) {
+    return Math.min(...arr);
+}
+exports.minArray = minArray;
+function maxArray(arr) {
+    return Math.max(...arr);
+}
+exports.maxArray = maxArray;
+function initArray(n, value) {
+    return Array.from(Array(n), () => value);
+}
+exports.initArray = initArray;
+function andArray(arr) {
+    return arr.reduce(function (a, b) { return a && b; }, true);
+}
+exports.andArray = andArray;
+// WORKING WITH OBJECT KEYS/PROPERTIES
+// TODO - Terry, is this copesetic?
+// Does an object have a key/property?
+function keyExists(k, o) {
+    return k in o;
+}
+exports.keyExists = keyExists;
+// TODO - Terry, can these three be combined into a generic isEmpty() check?
+// Does an object (dict) have any keys/properties?
+function isObjectEmpty(o) {
+    return Object.keys(o).length === 0;
+}
+exports.isObjectEmpty = isObjectEmpty;
+// Does a Set have any members?
+function isSetEmpty(s) {
+    return s.size === 0;
+}
+exports.isSetEmpty = isSetEmpty;
+// Does an array hold any items?
+function isArrayEmpty(a) {
+    if (a === undefined || a.length == 0) {
+        // array empty or does not exist
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+exports.isArrayEmpty = isArrayEmpty;
+// Get the keys for an object
+function getObjectKeys(o) {
+    return Object.keys(o);
+}
+exports.getObjectKeys = getObjectKeys;
+// TODO - Convert getNumericObjectKeys() idiom to for..of where possible
+function getNumericObjectKeys(o) {
+    return Object.keys(o).map(Number);
+}
+exports.getNumericObjectKeys = getNumericObjectKeys;
+function getSelectObjectKeys(o, v) {
+    let selectKeys = [];
+    Object.keys(o).forEach(key => {
+        if (arrayContains(v, o[key])) {
+            selectKeys.push(key);
+        }
+    });
+    return selectKeys;
+}
+exports.getSelectObjectKeys = getSelectObjectKeys;
+function arrayContains(a, item) {
+    return a.some(x => x === item);
+}
+exports.arrayContains = arrayContains;
+function objectContains(o, key) {
+    return (key in o);
+}
+exports.objectContains = objectContains;
+// ENUM HELPERS
+// Source: https://stackoverflow.com/questions/38034673/determine-the-number-of-enum-elements-typescript
+function countEnumValues(enumName) {
+    let count = 0;
+    for (let item in enumName) {
+        if (isNaN(Number(item)))
+            count++;
+    }
+    return count;
+}
+exports.countEnumValues = countEnumValues;
+// COPYING - Copied from dra-client/util.ts
+function shallowCopy(src) {
+    if (Array.isArray(src))
+        return src.slice();
+    else if (typeof src === 'object') {
+        let dst = {};
+        for (var p in src)
+            if (src.hasOwnProperty(p))
+                dst[p] = src[p];
+        return dst;
+    }
+    else
+        return src;
+}
+exports.shallowCopy = shallowCopy;
+function deepCopy(src) {
+    if (Array.isArray(src)) {
+        let dst = [];
+        for (let i = 0; i < src.length; i++)
+            dst.push(deepCopy(src[i]));
+        return dst;
+    }
+    else if (typeof src === 'object') {
+        let dst = {};
+        for (var p in src)
+            if (src.hasOwnProperty(p))
+                dst[p] = deepCopy(src[p]);
+        return dst;
+    }
+    else
+        return src;
+}
+exports.deepCopy = deepCopy;
+// TODO - Terry: What is this the simple explanation of what this thing is doing?
+var util_1 = require("@dra2020/util");
+exports.depthof = util_1.depthof;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,YAAY;AACZ,EAAE;;AAGF,gCAAgC;AAEhC,eAAe;AAEf,4BAA4B;AAC5B,SAAgB,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK,IAAI,CAAC,CAAC,YAAY,CAAC;AACjC,CAAC;AAFD,8BAEC;AAED,gCAAgC;AAChC,SAAgB,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK,IAAI,CAAC,CAAC,YAAY,CAAC;AACjC,CAAC;AAFD,oCAEC;AAED,kDAAkD;AAClD,SAAgB,WAAW,CAAC,IAAmB,EAAE,KAAa;IAC5D,0EAA0E;IAC1E,gFAAgF;IAChF,mFAAmF;IACnF,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;KACpB;SACI;QACH,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAVD,kCAUC;AAED,mEAAmE;AACnE,qEAAqE;AACrE,SAAgB,UAAU,CAAC,IAAmB;IAC5C,IAAI,YAAY,GAAG,EAAwB,CAAC;IAE5C,oCAAoC;IACpC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;IAEzC,KAAK,IAAI,KAAK,IAAI,IAAI,EAAE;QACtB,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAE7B,8CAA8C;QAC9C,IAAI,CAAC,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,EAAE;YAC/C,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;SACtC;QAED,wCAAwC;QACxC,YAAY,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACrC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAnBD,gCAmBC;AAED,sBAAsB;AAEtB,SAAgB,UAAU,CAAC,KAAa;IACtC,IAAI,KAAK,GAAiB,EAAE,CAAC;IAE7B,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAExC,IAAI,CAAC,GAAW,KAAK,CAAC,MAAM,CAAC;IAE7B,IAAI,CAAC,IAAI,EAAE,EAAE;QACX,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;KACzC;IAED,IAAI,CAAC,IAAI,EAAE,EAAE;QACX,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;KACtC;IAED,IAAI,CAAC,IAAI,EAAE,EAAE;QACX,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;KACxB;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AArBD,gCAqBC;AAED,SAAgB,sBAAsB,CAAC,KAAa;IAClD,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC;AAFD,wDAEC;AAGD,sBAAsB;AAEtB,4DAA4D;AAC5D,SAAgB,SAAS,CAAC,QAAgB,EAAE,KAAoB,EAAE,UAAmB,KAAK;IACxF,uDAAuD;IACvD,IAAI,OAAO,EAAE;QACX,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC;KAC3B;IAED,8CAA8C;IAC9C,IAAI,QAAQ,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,QAAQ,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEpE,qEAAqE;IACrE,IAAI,WAAW,GAAG,CAAC,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAEpE,kCAAkC;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC;AACtD,CAAC;AAhBD,8BAgBC;AAED,qEAAqE;AACrE,SAAgB,IAAI,CAAC,YAAoB;IACvC,IAAI,WAAW,GAAG,SAAA,EAAE,EAAI,CAAC,CAAC,SAAS,CAAA,CAAC;IAEpC,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,WAAW,CAAC;AAC9D,CAAC;AAJD,oBAIC;AAED,gBAAgB;AAEhB,SAAgB,QAAQ,CAAC,GAAa;IACpC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAFD,4BAEC;AAED,SAAgB,QAAQ,CAAC,GAAa;IACpC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC;AACvD,CAAC;AAFD,4BAEC;AAED,SAAgB,QAAQ,CAAC,GAAa;IACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAC1B,CAAC;AAFD,4BAEC;AAED,SAAgB,QAAQ,CAAC,GAAa;IACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAC1B,CAAC;AAFD,4BAEC;AAED,SAAgB,SAAS,CAAC,CAAS,EAAE,KAAU;IAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAFD,8BAEC;AAED,SAAgB,QAAQ,CAAC,GAAc;IACrC,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC;AAFD,4BAEC;AAED,sCAAsC;AAEtC,mCAAmC;AACnC,sCAAsC;AACtC,SAAgB,SAAS,CAAC,CAAS,EAAE,CAAS;IAC5C,OAAO,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAFD,8BAEC;AAED,4EAA4E;AAC5E,kDAAkD;AAClD,SAAgB,aAAa,CAAC,CAAS;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAA;AACpC,CAAC;AAFD,sCAEC;AACD,+BAA+B;AAC/B,SAAgB,UAAU,CAAC,CAAM;IAC/B,OAAO,CAAC,CAAC,IAAI,KAAK,CAAC,CAAA;AACrB,CAAC;AAFD,gCAEC;AACD,gCAAgC;AAChC,SAAgB,YAAY,CAAC,CAAQ;IACnC,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;QACpC,gCAAgC;QAChC,OAAO,IAAI,CAAC;KACb;SACI;QACH,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AARD,oCAQC;AAED,6BAA6B;AAC7B,SAAgB,aAAa,CAAC,CAAS;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACxB,CAAC;AAFD,sCAEC;AAED,wEAAwE;AACxE,SAAgB,oBAAoB,CAAC,CAAS;IAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAFD,oDAEC;AAED,SAAgB,mBAAmB,CAAC,CAAS,EAAE,CAAQ;IACrD,IAAI,UAAU,GAAa,EAAE,CAAC;IAE9B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC3B,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE;YAC5B,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAVD,kDAUC;AAED,SAAgB,aAAa,CAAC,CAAQ,EAAE,IAAS;IAC/C,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACjC,CAAC;AAFD,sCAEC;AAED,SAAgB,cAAc,CAAC,CAAS,EAAE,GAAQ;IAChD,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AACpB,CAAC;AAFD,wCAEC;AAGD,eAAe;AAEf,wGAAwG;AACxG,SAAgB,eAAe,CAAC,QAAa;IAC3C,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,KAAK,IAAI,IAAI,IAAI,QAAQ,EAAE;QACzB,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAAE,KAAK,EAAE,CAAA;KACjC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,0CAMC;AAED,2CAA2C;AAE3C,SAAgB,WAAW,CAAC,GAAQ;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACpB,OAAO,GAAG,CAAC,KAAK,EAAE,CAAC;SAChB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAChC,IAAI,GAAG,GAAQ,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,IAAI,GAAG;YAAE,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC1C,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,GAAG,CAAC;KACZ;;QAEC,OAAO,GAAG,CAAC;AACf,CAAC;AAXD,kCAWC;AAED,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACtB,IAAI,GAAG,GAAU,EAAE,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;YACzC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,OAAO,GAAG,CAAC;KACZ;SACI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAChC,IAAI,GAAG,GAAQ,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,IAAI,GAAG;YAAE,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC1C,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;KACZ;;QAEC,OAAO,GAAG,CAAC;AACf,CAAC;AAhBD,4BAgBC;AAGD,iFAAiF;AACjF,sCAAwC;AAA/B,yBAAA,OAAO,CAAA"}

package/lib/valid.d.ts

@@ -0,0 +1,5 @@
+import * as T from './types';
+import { AnalyticsSession } from './api';
+export declare function doIsComplete(s: AnalyticsSession): T.TestEntry;
+export declare function doIsContiguous(s: AnalyticsSession): T.TestEntry;
+export declare function doIsFreeOfHoles(s: AnalyticsSession): T.TestEntry;

package/lib/valid.js

@@ -0,0 +1,230 @@
+"use strict";
+//
+// MAP/PLAN VALIDATIONS
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+const U = require("./utils");
+const S = require("./settings");
+const D = require("./_data");
+//
+// COMPLETE - Are all geo's assigned to a district, and do all districts have
+//   at least one geo assigned to them?
+//
+function doIsComplete(s) {
+    let test = s.getTest(0 /* Complete */);
+    let bAllAssigned = true;
+    let bNoneEmpty = true;
+    let unassignedFeatures = [];
+    let emptyDistricts = [];
+    // Get the by district results, including the dummy unassigned district,
+    // but ignoring the N+1 summary district
+    let bNotEmptyByDistrict = s.districts.statistics[D.DistrictField.bNotEmpty];
+    bNotEmptyByDistrict = bNotEmptyByDistrict.slice(0, -1);
+    // Are all features assigned to districts?
+    // Check the dummy district that holds any unassigned features.
+    bAllAssigned = (!bNotEmptyByDistrict[S.NOT_ASSIGNED]);
+    if (!bAllAssigned) {
+        let unassignedDistrict = s.plan.geoIDsForDistrictID(S.NOT_ASSIGNED);
+        unassignedFeatures = Array.from(unassignedDistrict);
+        unassignedFeatures = unassignedFeatures.slice(0, S.NUMBER_OF_ITEMS_TO_REPORT);
+    }
+    // Do all real districts have at least one feature assigned to them?
+    bNoneEmpty = U.andArray(bNotEmptyByDistrict.slice(1));
+    // Case 1 - One or more districts are missing:
+    //   The # of enumerated districts minus the dummy NOT_ASSIGNED one should
+    //   equal the number apportioned districts. This guards against a district
+    //   not being included in a map that is imported.
+    //
+    // TODO - I'm no longer checking for this, but DRA should!
+    // Case 2 - Or a district is explicitly named but empty:
+    //   Note, this can happen if a district is created, and then all features
+    //   are removed from it (in DRA).
+    // Populate the test entry
+    test['score'] = bAllAssigned && bNoneEmpty;
+    if (!bAllAssigned) {
+        test['details']['unassignedFeatures'] = unassignedFeatures;
+    }
+    if (!bNoneEmpty) {
+        test['details']['emptyDistricts'] = emptyDistricts;
+    }
+    // Populate the N+1 summary "district" in district.statistics
+    let bNotEmpty = s.districts.statistics[D.DistrictField.bNotEmpty];
+    let summaryRow = s.districts.numberOfRows() - 1;
+    bNotEmpty[summaryRow] = test['score'];
+    return test;
+}
+exports.doIsComplete = doIsComplete;
+//
+// CONTIGUOUS - Is each district in a plan fully connected?
+//
+//   NOTE - To check "operational contiguity," we need to use a graph, i.e.,
+//   we can't rely on just the geometric contiguity of shapes in a shapefile.
+//
+//   To test this, load the NC 2010 map 'SAMPLE-BG-map-discontiguous.csv'.
+//
+function doIsContiguous(s) {
+    let test = s.getTest(1 /* Contiguous */);
+    // Get the contiguity of each district. Ignore dummy unassigned district
+    // and the N+1 summary district.
+    let bContiguousByDistrict = s.districts.statistics[D.DistrictField.bContiguous];
+    bContiguousByDistrict = bContiguousByDistrict.slice(1, -1);
+    // If any real districts aren't contiguous, mark the plan as not contiguous
+    let bMapContiguous = U.andArray(bContiguousByDistrict);
+    // If the map is not contiguous, log the offending districts.
+    let discontiguousDistricts = [];
+    let districtID = 1;
+    bContiguousByDistrict.forEach(function (bDistrictContiguous) {
+        if (!bDistrictContiguous)
+            discontiguousDistricts.push(districtID);
+        districtID += 1;
+    });
+    // Populate the test entry
+    test['score'] = bMapContiguous;
+    if (!bMapContiguous) {
+        test['details'] = { 'discontiguousDistricts': discontiguousDistricts };
+    }
+    // Populate the N+1 summary "district" in district.statistics
+    let bContiguous = s.districts.statistics[D.DistrictField.bContiguous];
+    let summaryRow = s.districts.numberOfRows() - 1;
+    bContiguous[summaryRow] = test['score'];
+    return test;
+}
+exports.doIsContiguous = doIsContiguous;
+// Are the features in a district fully connected?
+function isConnected(districtGeos, graph) {
+    // export function isConnected(districtGeos: Set<string>, graph: T.ContiguityGraph): boolean {
+    // TODO - Terry, why does this constructor need a <T> type specification?
+    let visited = new Set();
+    let toProcess = [];
+    // Start processing with the first geoID in the district
+    let iter = districtGeos.values();
+    toProcess.push(iter.next().value);
+    // While there are geoIDs in the district that haven't been processed
+    while (toProcess.length > 0) {
+        // Grab a geoID and process it
+        let node = toProcess.pop();
+        visited.add(node);
+        // Get its actual, in-state neighbors
+        let actualNeighbors = graph.peerNeighbors(node).filter(x => U.isInState(x));
+        // Add neighbors to visit, if they're in the same district Y haven't already been visited
+        let neighborsToVisit = actualNeighbors.filter(x => districtGeos.has(x) && (!visited.has(x)));
+        // TODO - Terry, is this the quickest/best way to do this?
+        toProcess.push(...neighborsToVisit);
+    }
+    // Stop when you've visited all the geoIDs in the district
+    return visited.size == districtGeos.size;
+}
+exports.isConnected = isConnected;
+//
+// FREE OF HOLES - Are any districts fully embedded w/in another district?
+//
+//   A district is NOT a "donut hole" district:
+//   - If any neighbor is 'OUT_OF_STATE'; or
+//   - If there are 2 or more neighboring districts.
+//
+//   To test this, load the NC 2010 map 'SAMPLE-BG-map-hole.csv'. District 1,
+//   Buncombe County (37021), is a donut hole w/in District 3.
+//
+// TODO - Optimize this to take advantage of district boundary info, if/when
+//   we cache one to optimize compactness.
+//
+function doIsFreeOfHoles(s) {
+    let test = s.getTest(2 /* FreeOfHoles */);
+    // Initialize values
+    let bFreeOfHoles = true;
+    let embeddedDistricts = [];
+    // Get the embeddedness of each district. Ignore dummy unassigned district
+    // and the N+1 summary district.
+    let bNotEmbeddedByDistrict = s.districts.statistics[D.DistrictField.bNotEmbedded];
+    bNotEmbeddedByDistrict = bNotEmbeddedByDistrict.slice(1, -1);
+    let districtID = 1;
+    bNotEmbeddedByDistrict.forEach(function (bDistrictNotEmbedded) {
+        if (!bDistrictNotEmbedded) {
+            embeddedDistricts.push(districtID);
+            bFreeOfHoles = false;
+        }
+        districtID += 1;
+    });
+    // Populate the test entry
+    test['score'] = bFreeOfHoles;
+    if (!bFreeOfHoles) {
+        test['details'] = { 'embeddedDistricts': embeddedDistricts };
+    }
+    // Populate the N+1 summary "district" in district.statistics
+    let bNotEmbedded = s.districts.statistics[D.DistrictField.bNotEmbedded];
+    let summaryRow = s.districts.numberOfRows() - 1;
+    bNotEmbedded[summaryRow] = test['score'];
+    return test;
+}
+exports.doIsFreeOfHoles = doIsFreeOfHoles;
+// Test whether one district is embedded w/in any other.
+function isEmbedded(districtID, geoIDs, plan, graph) {
+    // TODO - Make "features" = "geoIDs." These aren't "features" proper, just
+    //   identifier strings.
+    let features = geoIDs;
+    let planByGeo = plan.byGeoID();
+    // Assume the district is embedded
+    let bEmbedded = true;
+    // Keep track of the neighoring districts
+    let neighboringDistricts = new Set();
+    // TODO - Use just the boundary features, when available
+    // Get the features for the real district
+    let featuresToCheck = Array.from(features);
+    // If the district has features, check whether it is embedded
+    if (!(U.isArrayEmpty(featuresToCheck))) {
+        // For each feature that needs to be checked (see above)
+        for (let feature of featuresToCheck) {
+            // Get its neighbors (including the virtual "out of state" ones)
+            let neighbors = graph.peerNeighbors(feature);
+            for (let neighbor of neighbors) {
+                if (U.isOutOfState(neighbor)) {
+                    bEmbedded = false;
+                    // No need to check any more neighbors
+                    break;
+                }
+                else {
+                    let neighboringDistrict = U.getDistrict(planByGeo, neighbor);
+                    // Assume that a missing district assignment (= None) means that the
+                    // feature is "water-only" AND part of the state border (vs. internal)
+                    // and, therefore, not in the plan/map.
+                    if (neighboringDistrict == undefined) {
+                        bEmbedded = false;
+                        // No need to check any more neighbors
+                        break;
+                    }
+                    else {
+                        // TODO - Since we're checking *all* features in a district right
+                        //   now, not just boundary features and neighbors in other districts,
+                        //   prune out the current district. If/when we optimize compactness
+                        //   to cache district boundaries (as before in my Python implementation),
+                        //   we won't have to guard adding "neighboring" districts in this way.
+                        if (neighboringDistrict != districtID) {
+                            neighboringDistricts.add(neighboringDistrict);
+                        }
+                        if (neighboringDistricts.size > 1) {
+                            bEmbedded = false;
+                            // No need to check any more neighbors
+                            break;
+                        }
+                    }
+                }
+            }
+            // If a district is not embedded, there's no need to check anymore
+            // border geos.
+            if (!bEmbedded) {
+                break;
+            }
+        }
+    }
+    return bEmbedded;
+}
+exports.isEmbedded = isEmbedded;
+// TODO - MIXED MAPS
+// - When we generalize to mixed maps, the determination of "neighbors in
+//   the map" -- which is the core function in determining connectedness -- becomes
+//   *much* more complicated and dynamic.
+// - I can write up (if not implement) the logic for this. It is a bit tricky
+//   and requires special preprocessing of the summary level hierarchy (which I
+//   also have a script for that we can repurpose) to distinguish between 'interior'
+//   and 'edge' children.
+//# sourceMappingURL=valid.js.map

package/lib/valid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid.js","sourceRoot":"","sources":["../src/valid.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,uBAAuB;AACvB,EAAE;;AAGF,6BAA6B;AAC7B,gCAAgC;AAEhC,6BAA4B;AAG5B,EAAE;AACF,6EAA6E;AAC7E,uCAAuC;AACvC,EAAE;AAEF,SAAgB,YAAY,CAAC,CAAmB;IAC9C,IAAI,IAAI,GAAG,CAAC,CAAC,OAAO,kBAAgC,CAAC;IAErD,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,IAAI,UAAU,GAAG,IAAI,CAAC;IAEtB,IAAI,kBAAkB,GAAa,EAAE,CAAC;IACtC,IAAI,cAAc,GAAa,EAAE,CAAC;IAElC,wEAAwE;IACxE,wCAAwC;IACxC,IAAI,mBAAmB,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAC5E,mBAAmB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvD,0CAA0C;IAC1C,+DAA+D;IAC/D,YAAY,GAAG,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAI,CAAC,YAAY,EAAE;QACjB,IAAI,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACpE,kBAAkB,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACpD,kBAAkB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC;KAC/E;IAED,oEAAoE;IACpE,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtD,8CAA8C;IAC9C,0EAA0E;IAC1E,2EAA2E;IAC3E,kDAAkD;IAClD,EAAE;IACF,0DAA0D;IAE1D,wDAAwD;IACxD,0EAA0E;IAC1E,kCAAkC;IAElC,0BAA0B;IAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,YAAY,IAAI,UAAU,CAAC;IAC3C,IAAI,CAAC,YAAY,EAAE;QACjB,IAAI,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,GAAG,kBAAkB,CAAC;KAC5D;IAED,IAAI,CAAC,UAAU,EAAE;QACf,IAAI,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,GAAG,cAAc,CAAC;KACpD;IAED,6DAA6D;IAC7D,IAAI,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAEhD,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtC,OAAO,IAAI,CAAC;AACd,CAAC;AAtDD,oCAsDC;AAED,EAAE;AACF,2DAA2D;AAC3D,EAAE;AACF,4EAA4E;AAC5E,6EAA6E;AAC7E,EAAE;AACF,0EAA0E;AAC1E,EAAE;AAEF,SAAgB,cAAc,CAAC,CAAmB;IAChD,IAAI,IAAI,GAAG,CAAC,CAAC,OAAO,oBAAkC,CAAC;IAEvD,wEAAwE;IACxE,gCAAgC;IAChC,IAAI,qBAAqB,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAChF,qBAAqB,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE3D,2EAA2E;IAC3E,IAAI,cAAc,GAAG,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAEvD,6DAA6D;IAC7D,IAAI,sBAAsB,GAAa,EAAE,CAAC;IAC1C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,qBAAqB,CAAC,OAAO,CAAC,UAAU,mBAA4B;QAClE,IAAI,CAAC,mBAAmB;YAAE,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClE,UAAU,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,0BAA0B;IAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC;IAC/B,IAAI,CAAC,cAAc,EAAE;QACnB,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,CAAC;KACxE;IAED,6DAA6D;IAC7D,IAAI,WAAW,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACtE,IAAI,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAEhD,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAExC,OAAO,IAAI,CAAC;AACd,CAAC;AAhCD,wCAgCC;AAED,kDAAkD;AAClD,SAAgB,WAAW,CAAC,YAAyB,EAAE,KAAc;IACnE,8FAA8F;IAC9F,yEAAyE;IACzE,IAAI,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,IAAI,SAAS,GAAa,EAAE,CAAC;IAE7B,wDAAwD;IACxD,IAAI,IAAI,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;IACjC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IAElC,qEAAqE;IACrE,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,8BAA8B;QAC9B,IAAI,IAAI,GAAG,SAAS,CAAC,GAAG,EAAY,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,qCAAqC;QACrC,IAAI,eAAe,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5E,yFAAyF;QACzF,IAAI,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,0DAA0D;QAC1D,SAAS,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;KACrC;IAED,0DAA0D;IAC1D,OAAO,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC;AAC3C,CAAC;AA3BD,kCA2BC;AAGD,EAAE;AACF,0EAA0E;AAC1E,EAAE;AACF,+CAA+C;AAC/C,4CAA4C;AAC5C,oDAAoD;AACpD,EAAE;AACF,6EAA6E;AAC7E,8DAA8D;AAC9D,EAAE;AACF,4EAA4E;AAC5E,0CAA0C;AAC1C,EAAE;AAEF,SAAgB,eAAe,CAAC,CAAmB;IACjD,IAAI,IAAI,GAAG,CAAC,CAAC,OAAO,qBAAmC,CAAC;IAExD,oBAAoB;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,IAAI,iBAAiB,GAAa,EAAE,CAAC;IAErC,0EAA0E;IAC1E,gCAAgC;IAChC,IAAI,sBAAsB,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAClF,sBAAsB,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE7D,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,sBAAsB,CAAC,OAAO,CAAC,UAAU,oBAA6B;QACpE,IAAI,CAAC,oBAAoB,EAAE;YACzB,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACnC,YAAY,GAAG,KAAK,CAAC;SACtB;QACD,UAAU,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,0BAA0B;IAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC;IAC7B,IAAI,CAAC,YAAY,EAAE;QACjB,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,CAAC;KAC9D;IAED,6DAA6D;IAC7D,IAAI,YAAY,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACxE,IAAI,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAEhD,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAEzC,OAAO,IAAI,CAAC;AACd,CAAC;AAlCD,0CAkCC;AAED,wDAAwD;AACxD,SAAgB,UAAU,CAAC,UAAkB,EAAE,MAAmB,EAAE,IAAY,EAAE,KAAc;IAC9F,0EAA0E;IAC1E,wBAAwB;IACxB,IAAI,QAAQ,GAAG,MAAM,CAAC;IACtB,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAE/B,kCAAkC;IAClC,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,yCAAyC;IACzC,IAAI,oBAAoB,GAAG,IAAI,GAAG,EAAE,CAAC;IAErC,wDAAwD;IACxD,yCAAyC;IACzC,IAAI,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAE3C,6DAA6D;IAC7D,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,EAAE;QACtC,wDAAwD;QACxD,KAAK,IAAI,OAAO,IAAI,eAAe,EAAE;YACnC,gEAAgE;YAChE,IAAI,SAAS,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAE7C,KAAK,IAAI,QAAQ,IAAI,SAAS,EAAE;gBAC9B,IAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;oBAC5B,SAAS,GAAG,KAAK,CAAC;oBAClB,sCAAsC;oBACtC,MAAM;iBACP;qBACI;oBACH,IAAI,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;oBAE7D,oEAAoE;oBACpE,sEAAsE;oBACtE,uCAAuC;oBAEvC,IAAI,mBAAmB,IAAI,SAAS,EAAE;wBACpC,SAAS,GAAG,KAAK,CAAC;wBAClB,sCAAsC;wBACtC,MAAM;qBACP;yBACI;wBACH,iEAAiE;wBACjE,sEAAsE;wBACtE,oEAAoE;wBACpE,0EAA0E;wBAC1E,uEAAuE;wBACvE,IAAI,mBAAmB,IAAI,UAAU,EAAE;4BACrC,oBAAoB,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;yBAC/C;wBAED,IAAI,oBAAoB,CAAC,IAAI,GAAG,CAAC,EAAE;4BACjC,SAAS,GAAG,KAAK,CAAC;4BAClB,sCAAsC;4BACtC,MAAM;yBACP;qBACF;iBACF;aACF;YACD,kEAAkE;YAClE,eAAe;YACf,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM;aACP;SACF;KAEF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AApED,gCAoEC;AAED,oBAAoB;AACpB,yEAAyE;AACzE,mFAAmF;AACnF,yCAAyC;AACzC,6EAA6E;AAC7E,+EAA+E;AAC/E,oFAAoF;AACpF,yBAAyB"}

package/main.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+// Invoke the CLI
+var run = require('./dist/cli.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dra2020/district-analytics",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "District analytics TypeScript package",
   "main": "dist/district-analytics.js",
   "types": "dist/index.d.ts",
@@ -16,11 +16,6 @@
     "type": "git",
     "url": "git+https://github.com/dra2020/district-analytics.git"
   },
-  "files": [
-    "*/src/*",
-    "*/dist/*.*",
-    "*/dist/*/*.*"
-  ],
   "keywords": [
     "Typescript"
   ],
@@ -45,7 +40,7 @@
     "tslint": "^5.18.0",
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.5.3",
-    "webpack": "^4.39.2",
+    "webpack": "^4.39.3",
     "webpack-cli": "^3.3.7",
     "yargs": "^12.0.5"
   },

package/src/_api.ts

@@ -0,0 +1,121 @@
+//
+// THE NODE PACKAGE API
+//
+
+import { doPreprocessData } from './preprocess'
+import { doAnalyzePlan, doAnalyzeDistricts } from './analyze'
+import {
+  doConfigureScales, doAnalyzePostProcessing, doPrepareScorecard,
+  doPrepareTestLog, Scorecard
+} from './report'
+
+import * as D from './_data';
+import * as T from './types'
+import * as U from './utils';
+import * as S from './settings';
+
+export class AnalyticsSession {
+  title: string;
+  legislativeDistricts: boolean;
+  config: T.Dict = {};
+
+  bOneTimeProcessingDone = false;
+  bPlanAnalyzed = false;
+  bPostProcessingDone = false;
+  testScales = {} as T.TestScales;
+  tests = {} as T.TestEntries;
+  scorecard = {} as Scorecard;
+
+  state: D.State;
+  counties: D.Counties;
+  graph: D.Graph;
+  features: D.Features;
+  plan: D.Plan;
+  districts: D.Districts;
+
+  constructor(SessionRequest: T.SessionRequest) {
+    this.title = SessionRequest['title'];
+    this.legislativeDistricts = SessionRequest['legislativeDistricts'];
+    this.config = this.processConfig(SessionRequest['config'])
+
+    this.state = new D.State(this, SessionRequest['stateXX'], SessionRequest['nDistricts']);
+    this.counties = new D.Counties(this, SessionRequest['counties']);
+    this.graph = new D.Graph(this, SessionRequest['graph']);
+    this.features = new D.Features(this, SessionRequest['data'], this.config['datasets']);
+    this.plan = new D.Plan(this, SessionRequest['plan']);
+    this.districts = new D.Districts(this, SessionRequest['districtShapes']);
+
+    // NOTE: I've pulled these out of the individual analytics to here. Eventually,
+    // we could want them to passed into an analytics session as data, along with
+    // everything else. For now, this keeps branching out of the main code.
+    doConfigureScales(this);
+  }
+  processConfig(config: T.Dict): T.Dict {
+    // NOTE - Session settings are required:
+    // - Analytics suites can be defaulted to all with [], but
+    // - Dataset keys must be explicitly specified with 'dataset'
+
+    let defaultSuites = [T.Suite.Legal, T.Suite.Fair, T.Suite.Best];
+
+    // If the config passed in has no suites = [], use the default suites
+    if (U.isArrayEmpty(config['suites'])) {
+      config['suites'] = defaultSuites;
+    }
+
+    // Default the Census & redistricting cycle to 2010
+    if (!(U.keyExists('cycle', config))) config['cycle'] = 2010;
+
+    return config;
+  }
+
+  // Using the the data in the analytics session, calculate all the
+  // analytics & validations, saving/updating the individual test results.
+  analyzePlan(bLog: boolean = false): boolean {
+    try {
+      doPreprocessData(this);
+      doAnalyzeDistricts(this, bLog);
+      doAnalyzePlan(this, bLog);
+      doAnalyzePostProcessing(this);
+    }
+    catch {
+      console.log("Exception caught by analyzePlan()");
+      return false;
+    }
+
+    return true;
+  }
+
+  // Get an individual test, so you can drive UI with the results.
+  getTest(testID: T.Test): T.TestEntry {
+    // Get the existing test entries
+    // T.Test is a numeric enum, so convert the string keys to numbers
+    let testValues = U.getNumericObjectKeys(this.tests);
+
+    // If there's no entry for this test, create & initialize one
+    if (!(testValues.includes(testID))) {
+      this.tests[testID] = {} as T.TestEntry;
+      this.tests[testID]['score'] = undefined;
+      this.tests[testID]['details'] = {};
+    }
+
+    // Return a pointer to the the test entry for this test
+    return this.tests[testID];
+  }
+
+  // Prepare a scorecard for rendering
+  // NOTE - This assumes that analyzePlan() has been run!
+  prepareScorecard(): any {
+    return doPrepareScorecard(this);
+  }
+
+  // Prepare test results for rendering
+  // NOTE - This assumes that analyzePlan() has been run!
+  prepareTestLog(): any {
+    return doPrepareTestLog(this);
+  }
+
+  populationDeviationThreshold(): number {
+    return 1 - this.testScales[T.Test.PopulationDeviation]['testScale'][0];
+  }
+}
+