@dra2020/district-analytics 2.0.3 → 2.0.6

package/README.md

@@ -2,6 +2,10 @@
 
 Analytics for scoring congressional and legislative district maps.
 
+## Build Status
+
+[![CircleCI](https://circleci.com/gh/dra2020/district-analytics.svg?style=svg&circle-token=c487b4ab53586db25961a9a48388b794020901d1)](https://circleci.com/gh/dra2020/district-analytics)
+
 ## Sample Code
 
 ```javascript

package/dist/cli.js

@@ -8074,6 +8074,13 @@ class AnalyticsSession {
         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']);
+        // TODO - Confirming that the graph includes OUT_OF_STATE neighbors
+        // if (U.keyExists(S.OUT_OF_STATE, this.graph._graph)) {
+        //   console.log("Contiguity graph includes out-of-state neighbors.");
+        // }
+        // else {
+        //   console.log("Contiguity graph does NOT include out-of-state neighbors.");
+        // }
         // 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.
@@ -8183,6 +8190,9 @@ const S = __importStar(__webpack_require__(/*! ./settings */ "./src/settings.ts"
 const valid_1 = __webpack_require__(/*! ./valid */ "./src/valid.ts");
 const compact_1 = __webpack_require__(/*! ./compact */ "./src/compact.ts");
 const political_1 = __webpack_require__(/*! ./political */ "./src/political.ts");
+// DEBUG COUNTERS
+let nMissingDataset = 0;
+let nMissingProperty = 0;
 // DISTRICT STATISTICS
 // Indexes for statistics fields in Districts
 // NOTE - Not a const, so the number can be determined dynamically
@@ -8267,6 +8277,9 @@ class Districts {
     // TODO - OPTIMIZE by async'ing this?
     // TODO - Is there a way to do this programmatically off data? Does it matter?
     recalcStatistics(bLog = false) {
+        // Initialize debug counters
+        nMissingDataset = 0;
+        nMissingProperty = 0;
         // Compute these once per recalc cycle
         let targetSize = this._session.state.totalPop / this._session.state.nDistricts;
         let deviationThreshold = this._session.populationDeviationThreshold();
@@ -8504,6 +8517,8 @@ class Districts {
             this.statistics[DistrictField.AsianPct][summaryRow] = stateAsianPop / stateVAPPop;
             this.statistics[DistrictField.NativePct][summaryRow] = stateNativePop / stateVAPPop;
         }
+        console.log(`${nMissingDataset} features with missing datasets.`);
+        console.log(`${nMissingProperty} features with missing properties.`);
     }
     // NOTE - I did not roll these into district statistics, because creating the
     //   district shapes themselves is the big district-by-district activity, these
@@ -8558,36 +8573,46 @@ 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']) {
+        if (!f.properties['datasets'][datasetKey]) {
+            // Feature is missing the dataset
+            nMissingDataset += 1;
+            console.log(`${nMissingDataset}: Data ${datasetKey} missing for feature ${f} Returning zero.`);
+            return 0;
+        }
         return f.properties['datasets'][datasetKey][p];
     }
     // NOTE - The fGetW() code from dra-client below here ...
     // Direct property?
-    if (f.properties && f.properties[p] !== undefined)
+    if (f.properties && f.properties[p] !== undefined) {
         return f.properties[p];
+    }
     // Joined property?
     let a = _fGetJoined(f);
     if (a) {
         for (let i = 0; i < a.length; i++) {
             let o = a[i];
             if (!datasetKey) {
-                if (o[p] !== undefined)
+                if (o[p] !== undefined) {
                     return o[p];
+                }
             }
             else {
                 if (o['datasets'] && o['datasets'][datasetKey]) {
                     let v = (o['datasets'][datasetKey][p]);
-                    if ((!(v == null)) && (!(v == undefined)))
+                    if ((!(v == null)) && (!(v == undefined))) {
                         return o['datasets'][datasetKey][p];
+                    }
                 }
             }
         }
     }
-    console.log(`${p} value undefined for ${f.properties['GEOID10']}!`);
-    return undefined;
+    // Feature is missing the property
+    nMissingProperty += 1;
+    console.log(`${nMissingProperty}: ${p} value undefined for ${f.properties['GEOID10']}. Returning zero.`);
+    return 0;
+    // return undefined;
 }
 function _fGetJoined(f) {
     return (f.properties && f.properties.joined) ? f.properties.joined : undefined;
@@ -8632,6 +8657,7 @@ class Plan {
     }
     // NOTE - DON'T remove water-only features from the plan, as they may be required
     // for contiguity. Just skip them in aggregating district statistics.
+    //
     // removeWaterOnlyFeatures(plan: T.PlanByGeoID): T.PlanByGeoID {
     //   let newPlan = {} as T.PlanByGeoID;
     //   for (let geoID in plan) {
@@ -9135,7 +9161,7 @@ exports.doFindCountiesSplitUnexpectedly = doFindCountiesSplitUnexpectedly;
 function doFindSplitVTDs(s, bLog = false) {
     let test = s.getTest(10 /* VTDSplits */);
     let splitVTDs = [];
-    // TODO - SPLITTING: Flesh this out, using Terry's virtual VTD's ...
+    // TODO - SPLITTING: Flesh this out, using virtual VTD's ...
     test['score'] = splitVTDs.length;
     test['details']['splitVTDs'] = splitVTDs;
     return test;
@@ -9382,17 +9408,22 @@ const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
 const D = __importStar(__webpack_require__(/*! ./_data */ "./src/_data.ts"));
 function doPopulationDeviation(s, bLog = false) {
     let test = s.getTest(4 /* PopulationDeviation */);
-    // Compute the min, max, and average district populations,
-    // excluding the dummy 'unassigned' 0 and N+1 summary "districts."
+    let targetSize = s.state.totalPop / s.state.nDistricts;
+    // Compute the min & max district populations
+    // ... excluding the dummy the 'unassigned' 0 and N+1 summary "districts"
     let totPopByDistrict = s.districts.statistics[D.DistrictField.TotalPop];
     totPopByDistrict = totPopByDistrict.slice(1, -1);
-    let min = U.minArray(totPopByDistrict);
-    let max = U.maxArray(totPopByDistrict);
-    let total = U.sumArray(totPopByDistrict);
-    // Calculate the raw population deviation.
-    // The target size is the average population.
-    let avg = total / s.state.nDistricts;
-    let popDev = (max - min) / avg;
+    // Remove empty districts
+    totPopByDistrict = totPopByDistrict.filter(x => x > 0);
+    let min = 0;
+    let max = 0;
+    // If there's more than 1 non-empty district, calculate a non-zero deviation
+    if (totPopByDistrict.length > 1) {
+        min = U.minArray(totPopByDistrict);
+        max = U.maxArray(totPopByDistrict);
+    }
+    // Calculate the raw population deviation
+    let popDev = (max - min) / targetSize;
     // Round the raw value to the desired level of precision
     popDev = U.trim(popDev);
     // Populate the test entry
@@ -9402,7 +9433,7 @@ function doPopulationDeviation(s, bLog = false) {
     let totalPop = s.districts.statistics[D.DistrictField.TotalPop];
     let popDevPct = s.districts.statistics[D.DistrictField.PopDevPct];
     let summaryRow = s.districts.numberOfRows() - 1;
-    totalPop[summaryRow] = avg; // aka "target size"
+    totalPop[summaryRow] = targetSize;
     popDevPct[summaryRow] = popDev;
     return test;
 }
@@ -9766,9 +9797,9 @@ function doPreprocessCensus(s, bLog = false) {
             // Sum total population by county
             totalByCounty[countyFIPS] += value;
         }
-        // else {
-        //   console.log("Skipping water-only feature in Census preprocessing:", geoID);
-        // }
+        else {
+            console.log("Skipping water-only feature in Census preprocessing:", geoID);
+        }
     }
     // NOTE - The above could be replaced, if I got totals on county.geojson.
     // CREATE A FIPS CODE-ORDINAL MAP