@dra2020/district-analytics 1.0.11 → 2.0.0

package/dist/district-analytics.js

@@ -148,7 +148,7 @@ class AnalyticsSession {
         // NOTE - Session settings are required:
         // - Analytics suites can be defaulted to all with [], but
         // - Dataset keys must be explicitly specified with 'dataset'
-        // TODO - Remove this mechanism. Always run everything.
+        // TODO - DASHBOARD: Remove this mechanism. Always run everything.
         let defaultSuites = [0 /* Legal */, 1 /* Fair */, 2 /* Best */];
         // If the config passed in has no suites = [], use the default suites
         if (U.isArrayEmpty(config['suites'])) {
@@ -328,10 +328,10 @@ class Districts {
     }
     // This is the workhorse computational routine!
     //
-    // TODO - Optimize for getting multiple properties from the same feature?
-    // TODO - Optimize by only re-calc'ing districts that have changed?
+    // TODO - OPTIMIZE for getting multiple properties from the same feature?
+    // TODO - OPTIMIZE by only re-calc'ing districts that have changed?
     //        In this case, special attention to getting county-splits right.
-    // TODO - Optimize by async'ing this?
+    // TODO - OPTIMIZE by async'ing this?
     // TODO - Is there a way to do this programmatically off data? Does it matter?
     recalcStatistics(bLog = false) {
         // Compute these once per recalc cycle
@@ -340,7 +340,7 @@ class Districts {
         let planByDistrict = this._session.plan.byDistrictID();
         let plan = this._session.plan;
         let graph = this._session.graph;
-        // TODO - SPLITTING
+        // NOTE - SPLITTING
         // Add an extra 0th virtual county bucket for county-district splitting analysis 
         let nCountyBuckets = this._session.counties.nCounties + 1;
         // INITIALIZE STATE VALUES THAT WILL BE ACCUMULATED
@@ -366,7 +366,7 @@ class Districts {
             // INITIALIZE DISTRICT VALUES THAT WILL BE ACCUMULATED (VS. DERIVED)
             let featurePop;
             let totalPop = 0;
-            // TODO - SPLITTING
+            // NOTE - SPLITTING
             let countySplits = U.initArray(nCountyBuckets, 0);
             let demVotes = 0;
             let repVotes = 0;
@@ -397,31 +397,37 @@ class Districts {
                         // Map from geoID to feature index
                         let featureID = outerThis._session.features.featureID(geoID);
                         let f = outerThis._session.features.featureByIndex(featureID);
-                        // ACCUMULATE VALUES
-                        // Total population of each feature
-                        // NOTE - This result is used more than once
-                        featurePop = outerThis._session.features.fieldForFeature(f, "CENSUS" /* CENSUS */, "Tot" /* TotalPop */);
-                        // Total district population
-                        totalPop += featurePop;
-                        // TODO - SPLITTING
-                        // Total population by counties w/in a district,
-                        // except the dummy unassigned district 0
-                        if (i > 0)
-                            countySplits[outerThis.getCountyIndex(geoID)] += featurePop;
-                        // Democratic and Republican vote totals
-                        demVotes += outerThis._session.features.fieldForFeature(f, "ELECTION" /* ELECTION */, "D" /* DemVotes */);
-                        repVotes += outerThis._session.features.fieldForFeature(f, "ELECTION" /* ELECTION */, "R" /* RepVotes */);
-                        // Voting-age demographic breakdowns (or citizen voting-age)
-                        totalVAP += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "Tot" /* TotalPop */);
-                        whitePop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "Wh" /* WhitePop */);
-                        blackPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "BlC" /* BlackPop */);
-                        hispanicPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "His" /* HispanicPop */);
-                        pacificPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "PacC" /* PacificPop */);
-                        asianPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "AsnC" /* AsianPop */);
-                        nativePop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "NatC" /* NativePop */);
-                        // 4 - MORE ...
+                        if (f == undefined) {
+                            console.log("Skipping undefined feature in district statistics: GEOID =", geoID, "Feature ID =", featureID);
+                        }
+                        else {
+                            // ACCUMULATE VALUES
+                            // Total population of each feature
+                            // NOTE - This result is used more than once
+                            featurePop = outerThis._session.features.fieldForFeature(f, "CENSUS" /* CENSUS */, "Tot" /* TotalPop */);
+                            // Total district population
+                            totalPop += featurePop;
+                            // NOTE - SPLITTING
+                            // Total population by counties w/in a district,
+                            // except the dummy unassigned district 0
+                            if (i > 0)
+                                countySplits[outerThis.getCountyIndex(geoID)] += featurePop;
+                            // Democratic and Republican vote totals
+                            demVotes += outerThis._session.features.fieldForFeature(f, "ELECTION" /* ELECTION */, "D" /* DemVotes */);
+                            repVotes += outerThis._session.features.fieldForFeature(f, "ELECTION" /* ELECTION */, "R" /* RepVotes */);
+                            // Voting-age demographic breakdowns (or citizen voting-age)
+                            totalVAP += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "Tot" /* TotalPop */);
+                            whitePop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "Wh" /* WhitePop */);
+                            blackPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "BlC" /* BlackPop */);
+                            hispanicPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "His" /* HispanicPop */);
+                            pacificPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "PacC" /* PacificPop */);
+                            asianPop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "AsnC" /* AsianPop */);
+                            nativePop += outerThis._session.features.fieldForFeature(f, "VAP" /* VAP */, "NatC" /* NativePop */);
+                            // 4 - MORE ...
+                        }
                     }
-                    // else console.log("Skipping water-only feature in district statistics:", geoID);
+                    else
+                        console.log("Skipping water-only feature in district statistics:", geoID);
                 });
                 // COMPUTE DERIVED VALUES
                 // Population deviation % and equal population (boolean) by district.
@@ -619,6 +625,8 @@ exports.Features = Features;
 //  f is a direct GeoJSON feature
 //  p is a geoID
 function _getFeatures(f, datasetKey, p) {
+    // Echo parameters for debugging
+    // console.log("f =", f, "k = ", datasetKey, "p =", p);
     // Shim to load sample data2.json from disk for command-line scaffolding
     if (f.properties && f.properties['datasets']) {
         return f.properties['datasets'][datasetKey][p];
@@ -705,7 +713,7 @@ class Plan {
     //   return newPlan;
     // }
     invertPlan() {
-        // TODO - UNASSIGNED
+        // NOTE - UNASSIGNED
         this._planByDistrictID = invertPlan(this._planByGeoID, this._session);
         this.districtIDs = U.getNumericObjectKeys(this._planByDistrictID);
     }
@@ -721,8 +729,8 @@ function invertPlan(plan, s) {
     let invertedPlan = {};
     // Add a dummy 'unassigned' district
     invertedPlan[S.NOT_ASSIGNED] = new Set();
-    // TODO - UNASSIGNED
-    // NOTE - The feature assignments coming from DRA do not include unassigned ones.
+    // NOTE - UNASSIGNED
+    // The feature assignments coming from DRA do not include unassigned ones.
     // - In the DRA-calling context, there's an analytics session with a reference
     //   to the features. Loop over all the features to find the unassigned ones,
     //   and add them to the dummy unassigned district explicitly.
@@ -735,7 +743,7 @@ function invertPlan(plan, s) {
             // to the dummy unassigned district 0.
             if (!(U.keyExists(geoID, plan)))
                 invertedPlan[S.NOT_ASSIGNED].add(geoID);
-            // TODO - WATER-ONLY: NOT skipping water-only features here, because we're
+            // NOTE - NOT skipping WATER-ONLY features here, because we're
             // not skipping them below when they are explicitly assigned in plans. Should
             // we skip them in both places?
         }
@@ -762,7 +770,13 @@ class Graph {
     peerNeighbors(node) {
         // Get the neighboring geoIDs connected to a geoID
         // Ignore the lengths of the shared borders (the values), for now
-        return U.getObjectKeys(this._graph[node]);
+        // Protect against getting a GEOID that's not in the graph
+        if (U.keyExists(node, this._graph)) {
+            return U.getObjectKeys(this._graph[node]);
+        }
+        else
+            return [];
+        // return U.getObjectKeys(this._graph[node]);
     }
 }
 exports.Graph = Graph;
@@ -1505,7 +1519,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Poly = __importStar(__webpack_require__(/*! @dra2020/poly */ "@dra2020/poly"));
 // CARTESIAN SHIMS OVER 'POLY' FUNCTIONS
-// TODO - TERRY: Confirm Cartesian calculations
+// TODO - POLY: Confirm Cartesian calculations
 function gfArea(poly) {
     let area = _polygonArea(poly);
     return area;
@@ -1540,7 +1554,7 @@ function _polygonSimpleArea(p) {
 // Generalizes the above for MultiPolygons -- cloned from polyArea() in 'poly'
 function _polygonArea(poly) {
     let polyOptions = { noLatitudeCorrection: true }; // NO-OP?
-    poly = Poly.polyNormalize(poly, polyOptions); // TODO - Discuss w/ Terry
+    poly = Poly.polyNormalize(poly, polyOptions); // TODO - POLY: Discuss w/ Terry
     let a = 0;
     // A MultiPolygon is a set of polygons
     for (let i = 0; poly && i < poly.length; i++) {
@@ -1553,7 +1567,7 @@ function _polygonArea(poly) {
     }
     return a;
 }
-// TODO - TERRY: Confirm Cartesian calculations
+// TODO - POLY: Confirm Cartesian calculations w/ Terry
 // The perimeter calculation already just computes cartesian distance if you
 // pass in the noLatitudeCorrection flag. You would need to divide by 
 // Poly.EARTH_RADIUS to go from the returned units of meters to Lat/Lon “units”.
@@ -1562,7 +1576,7 @@ function gfPerimeter(poly) {
     return perimeter;
 }
 exports.gfPerimeter = gfPerimeter;
-// TODO - TERRY: Confirm Cartesian calculations
+// TODO - POLY: Confirm Cartesian calculations w/ Terry
 // Cloned from polyPerimeter() in 'poly' and revised to use Cartesian distance
 // NOTE: No conversion of degrees to radians!
 function _polygonPerimeter(poly) {
@@ -1586,7 +1600,7 @@ function _distance(x1, y1, x2, y2) {
     d = Math.sqrt((dLat * dLat) + (dLon * dLon));
     return d;
 }
-// TODO - TERRY: Confirm Cartesian calculations
+// TODO - POLY: Confirm Cartesian calculations w/ Terry
 // As I mentioned, the polyCircle code was already just treating the coordinate
 // system as Cartesian. I then did polyFromCircle to convert it to a polygon that
 // then could be passed to polyArea in order to take into account the projection.
@@ -1620,6 +1634,7 @@ function __export(m) {
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(__webpack_require__(/*! ./_api */ "./src/_api.ts"));
+__export(__webpack_require__(/*! ./_data */ "./src/_data.ts"));
 __export(__webpack_require__(/*! ./results */ "./src/results.ts"));
 __export(__webpack_require__(/*! ./types */ "./src/types.ts"));
 
@@ -1795,7 +1810,7 @@ function doPreprocessData(s, bLog = false) {
         doPreprocessElection(s, bLog);
         s.bOneTimeProcessingDone = true;
     }
-    // TODO - UNASSIGNED: Made both the planByGeoID & DistrictID are right
+    // NOTE - UNASSIGNED: Made both the planByGeoID & DistrictID are right
     // Invert the plan by district ID
     s.plan.invertPlan();
     // Create a map of geoIDs to feature IDs
@@ -1847,7 +1862,7 @@ function doPreprocessCensus(s, bLog = false) {
     let fipsCodes = U.getObjectKeys(totalByCounty);
     // Sort the results
     fipsCodes = fipsCodes.sort();
-    // TODO - SPLITTING
+    // NOTE - SPLITTING
     // Add a dummy county, for county-district splitting analysis
     fipsCodes.unshift('000');
     // Create the ID-ordinal map
@@ -1878,7 +1893,7 @@ function doPreprocessCensus(s, bLog = false) {
     // Loop over the counties
     for (let county in fipsCodes) {
         let fipsCode = fipsCodes[county];
-        // TODO - SPLITTING
+        // NOTE - SPLITTING
         // Skip the dummy county
         if (fipsCode == '000')
             continue;
@@ -1936,8 +1951,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
 const S = __importStar(__webpack_require__(/*! ./settings */ "./src/settings.ts"));
 const D = __importStar(__webpack_require__(/*! ./_data */ "./src/_data.ts"));
-// TODO - DASHBOARD: Delete
-// import { doAnalyzePostProcessing } from './report'
 const analyze_1 = __webpack_require__(/*! ./analyze */ "./src/analyze.ts");
 const state_reqs_json_1 = __importDefault(__webpack_require__(/*! ../static/state-reqs.json */ "./static/state-reqs.json"));
 // Example
@@ -1988,12 +2001,12 @@ let sampleSplitting = {
         ],
         unexpectedAffected: 0.3096,
         nSplitVTDs: 12,
-        splitVTDs: []
+        splitVTDs: ["VTD-01", "VTD-02", "VTD-03", "VTD-04", "VTD-05", "VTD-06", "VTD-07", "VTD-08", "VTD-09", "VTD-10", "VTD-11", "VTD-12"]
     },
     datasets: {},
     resources: {}
 };
-// TODO - This category is still being fleshed out.
+// TODO - PARTISAN: This category is still being fleshed out.
 let samplePartisan = {
     score: 100,
     metrics: {
@@ -2008,7 +2021,7 @@ let samplePartisan = {
         planScore: "https://planscore.org/plan.html?20180219T202039.596761160Z"
     }
 };
-// TODO - This category is still being fleshed out.
+// TODO - MINORITY: This category is still being fleshed out.
 let sampleMinority = {
     score: null,
     metrics: {
@@ -2126,9 +2139,9 @@ function preparePlanAnalytics(s, bLog = false) {
             // None at this time
             },
             datasets: {
-                shapes: "2010 VTD shapes"
-                // TODO - DATASETS
-                // shapes: U.deepCopy(s.config['descriptions']['SHAPES'])
+                // NOTE - DATASETS
+                shapes: U.deepCopy(s.config['descriptions']['SHAPES'])
+                // shapes: "2010 VTD shapes"
             },
             resources: {
             // None at this time
@@ -2379,7 +2392,7 @@ const polsbyPopperDefn = {
     externalType: TestType.Number,
     suites: [2 /* Best */]
 };
-// TODO - SPLITTING
+// NOTE - SPLITTING
 const unexpectedCountySplitsDefn = {
     ID: 7 /* UnexpectedCountySplits */,
     name: "Unexpected County Splits",
@@ -2387,7 +2400,7 @@ const unexpectedCountySplitsDefn = {
     externalType: TestType.Percentage,
     suites: [2 /* Best */]
 };
-// TODO - SPLITTING
+// NOTE - SPLITTING
 const VTDSplitsDefn = {
     ID: 10 /* VTDSplits */,
     name: "VTD Splits",
@@ -2395,7 +2408,7 @@ const VTDSplitsDefn = {
     externalType: TestType.Number,
     suites: [2 /* Best */]
 };
-// TODO - SPLITTING
+// NOTE - SPLITTING
 const countySplittingDefn = {
     ID: 8 /* CountySplitting */,
     name: "County Splitting",
@@ -2403,7 +2416,7 @@ const countySplittingDefn = {
     externalType: TestType.Number,
     suites: [2 /* Best */]
 };
-// TODO - SPLITTING
+// NOTE - SPLITTING
 const districtSplittingDefn = {
     ID: 9 /* DistrictSplitting */,
     name: "District Splitting",
@@ -2427,7 +2440,7 @@ const testDefns = {
     [4 /* PopulationDeviation */]: populationDeviationDefn,
     [5 /* Reock */]: reockDefn,
     [6 /* PolsbyPopper */]: polsbyPopperDefn,
-    // TODO - SPLITTING
+    // NOTE - SPLITTING
     [7 /* UnexpectedCountySplits */]: unexpectedCountySplitsDefn,
     [10 /* VTDSplits */]: VTDSplitsDefn,
     [8 /* CountySplitting */]: countySplittingDefn,
@@ -2455,7 +2468,7 @@ function doConfigureScales(s) {
     s.testScales[6 /* PolsbyPopper */] = { scale: [0.10, 0.50] };
     const nDistricts = s.state.nDistricts;
     const nCounties = s.counties.nCounties;
-    // TODO - SPLITTING: Experiment w/ this multiplier. Only allowing the expected
+    // NOTE - SPLITTING: Experiment w/ this multiplier. Only allowing the expected
     //   number of county splits seems too stringent, empirically. 
     const allowableCountySplitsMultiplier = 1.5;
     const nAllowableSplits = Math.min(allowableCountySplitsMultiplier * (nDistricts - 1));
@@ -2514,7 +2527,7 @@ exports.PRECISION = 4;
 exports.NORMALIZED_RANGE = 100;
 // The dummy district ID for features not assigned districts yet
 exports.NOT_ASSIGNED = 0;
-// TODO - TERRY/DAVE: Discuss
+// TODO - DASHBOARD: Discuss w/ Dave
 // # of items to report as problematic (e.g., features, districts, etc.)
 exports.NUMBER_OF_ITEMS_TO_REPORT = 10;
 // The virtual geoID for "neighbors" in other states
@@ -2579,7 +2592,7 @@ function isOutOfState(geoID) {
     return geoID == S.OUT_OF_STATE;
 }
 exports.isOutOfState = isOutOfState;
-// TODO - UNASSIGNED
+// NOTE - UNASSIGNED
 // 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
@@ -2637,7 +2650,7 @@ function normalize(rawScore, testScale) {
     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);
-    // TODO - SPLITTING
+    // NOTE - SPLITTING
     // Invert the scaled value if necessary to make bigger = better
     if (testScale.bInvertScaled) {
         scaledValue = 1.0 - scaledValue;