@dra2020/district-analytics 3.1.0 → 3.2.0

package/dist/district-analytics.js

@@ -143,37 +143,47 @@ class AnalyticsSession {
         this.districts = new D.Districts(this, SessionRequest['districtShapes']);
         // TODO - SCORE: Toggle
         if (this.useLegacy()) {
+            console.log("Using legacy district-analytics.");
             // 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.
             results_1.doConfigureScales(this);
         }
+        else {
+            console.log("Using dra-score analytics.");
+            // TODO - SCORE: Temporary HACK. Query dra-score for threshold.
+            results_1.doConfigureScales(this);
+        }
     }
     processConfig(config) {
         // NOTE - Session settings are required:
         // - Analytics suites can be defaulted to all with [], but
         // - Dataset keys must be explicitly specified with 'dataset'
+        // TODO - SCORE: Delete
         config['suites'] = [0 /* Legal */, 1 /* Fair */, 2 /* Best */];
         // Default the Census & redistricting cycle to 2010
         if (!(U.keyExists('cycle', config)))
             config['cycle'] = 2010;
         return config;
     }
+    // TODO - SCORE: Toggle = Invert this logic
     useLegacy() {
-        return (U.keyExists('useScore', this.config) && (this.config['useScore'])) ? false : true;
+        // TODO - SCORE: Opt-out
+        return (U.keyExists('useScore', this.config) && (this.config['useScore'] != null) && (!(this.config['useScore']))) ? true : false;
+        // TODO - SCORE: Opt-in
+        // return (U.keyExists('useScore', this.config) && (this.config['useScore'])) ? false : true;
     }
     // Using the the data in the analytics session, calculate all the
     // analytics & validations, saving/updating the individual test results.
-    analyzePlan(bLog = false, overridesJSON = undefined) {
+    analyzePlan(bLog = false, overridesJSON) {
         try {
             preprocess_1.doPreprocessData(this, bLog);
             analyze_1.doAnalyzeDistricts(this, bLog);
-            // TODO - SCORE
             analyze_1.doAnalyzePlan(this, bLog);
+            // TODO - SCORE
             this._profile = score_1.profilePlan(this, bLog);
-            this._scorecard = score_1.scorePlan(this._profile, bLog);
+            this._scorecard = score_1.scorePlan(this, this._profile, bLog, overridesJSON);
             results_1.doAnalyzePostProcessing(this, bLog);
-            //
         }
         catch (_a) {
             console.log("Exception caught by analyzePlan()");
@@ -295,13 +305,13 @@ class AnalyticsSession {
     // NOTE - Not sure why this has to be up here ...
     populationDeviationThreshold() {
         // TODO - SCORE: Toggle
-        // const bLegacy = this._bLegacy; DELETE
         if (this.useLegacy()) {
             return 1 - this.testScales[4 /* PopulationDeviation */]['scale'][0];
         }
         else {
-            const scorecard = this._scorecard;
-            return scorecard.best.populationDeviation.notes['threshold'];
+            // TODO - SCORE: Temporary HACK. Query dra-score for threshold.
+            // NOTE - The plan may not have been scored yet, i.e., no scorecard yet.
+            return 1 - this.testScales[4 /* PopulationDeviation */]['scale'][0];
         }
     }
 }
@@ -478,7 +488,6 @@ class Districts {
             let outerThis = this;
             // Default the pop dev % for the dummy Unassigned district to 0%.
             // Default the pop dev % for real (1–N) but empty districts to 100%.
-            // TODO - SCORE: Why did I mark this?
             let popDevPct = (i > 0) ? (targetSize / targetSize) : 0 / targetSize;
             // Get the geoIDs assigned to the district
             // Guard against empty districts
@@ -928,12 +937,44 @@ exports.doAnalyzeDistricts = doAnalyzeDistricts;
 //   calls might make chunking for aync easier.
 function doAnalyzePlan(s, bLog = false) {
     // TODO - SCORE: Toggle
-    // const bLegacy = s._bLegacy;
-    // TODO - Remove this mechanism. Always run all tests
-    // Get the requested suites, and only execute those tests
-    let requestedSuites = s.config['suites'];
-    // Tests in the "Legal" suite, i.e., pass/ fail constraints
-    if (requestedSuites.includes(0 /* Legal */)) {
+    if (s.useLegacy()) {
+        // Disable most legacy analytics
+        // Get the requested suites, and only execute those tests
+        let requestedSuites = s.config['suites'];
+        // Tests in the "Legal" suite, i.e., pass/ fail constraints
+        if (requestedSuites.includes(0 /* Legal */)) {
+            s.tests[0 /* Complete */] = valid_1.doIsComplete(s, bLog);
+            s.tests[1 /* Contiguous */] = valid_1.doIsContiguous(s, bLog);
+            s.tests[2 /* FreeOfHoles */] = valid_1.doIsFreeOfHoles(s, bLog);
+            s.tests[4 /* PopulationDeviation */] = equal_1.doPopulationDeviation(s, bLog);
+            // NOTE - I can't check whether a population deviation is legal or not, until
+            // the raw % is normalized. A zero (0) would mean "too much" / "not legal," for
+            // the given type of district (CD vs. LD). The EqualPopulation test is derived
+            // from PopulationDeviation, as part of scorecard or test log preparation.
+            // Create an empty test entry here though ...
+            s.tests[3 /* EqualPopulation */] = s.getTest(3 /* EqualPopulation */);
+        }
+        // Tests in the "Fair" suite
+        if (requestedSuites.includes(1 /* Fair */)) {
+            s.tests[11 /* SeatsBias */] = political_1.doSeatsBias(s, bLog);
+            s.tests[12 /* VotesBias */] = political_1.doVotesBias(s, bLog);
+            s.tests[13 /* Responsiveness */] = political_1.doResponsiveness(s, bLog);
+            s.tests[14 /* ResponsiveDistricts */] = political_1.doResponsiveDistricts(s, bLog);
+            s.tests[15 /* EfficiencyGap */] = political_1.doEfficiencyGap(s, bLog);
+            s.tests[16 /* MajorityMinorityDistricts */] = minority_1.doMajorityMinorityDistricts(s, bLog);
+        }
+        // Tests in the "Best" suite, i.e., criteria for better/worse
+        if (requestedSuites.includes(2 /* Best */)) {
+            s.tests[5 /* Reock */] = compact_1.doReock(s, bLog);
+            s.tests[6 /* PolsbyPopper */] = compact_1.doPolsbyPopper(s, bLog);
+            s.tests[7 /* UnexpectedCountySplits */] = cohesive_1.doFindCountiesSplitUnexpectedly(s, bLog);
+            s.tests[10 /* VTDSplits */] = cohesive_1.doFindSplitVTDs(s, bLog);
+            s.tests[8 /* CountySplitting */] = cohesive_1.doCountySplitting(s, bLog);
+            s.tests[9 /* DistrictSplitting */] = cohesive_1.doDistrictSplitting(s, bLog);
+        }
+    }
+    else {
+        // TODO - SCORE: Except these. Continue to do these here vs. dra-score.
         s.tests[0 /* Complete */] = valid_1.doIsComplete(s, bLog);
         s.tests[1 /* Contiguous */] = valid_1.doIsContiguous(s, bLog);
         s.tests[2 /* FreeOfHoles */] = valid_1.doIsFreeOfHoles(s, bLog);
@@ -944,24 +985,8 @@ function doAnalyzePlan(s, bLog = false) {
         // from PopulationDeviation, as part of scorecard or test log preparation.
         // Create an empty test entry here though ...
         s.tests[3 /* EqualPopulation */] = s.getTest(3 /* EqualPopulation */);
-    }
-    // Tests in the "Fair" suite
-    if (requestedSuites.includes(1 /* Fair */)) {
-        s.tests[11 /* SeatsBias */] = political_1.doSeatsBias(s, bLog);
-        s.tests[12 /* VotesBias */] = political_1.doVotesBias(s, bLog);
-        s.tests[13 /* Responsiveness */] = political_1.doResponsiveness(s, bLog);
-        s.tests[14 /* ResponsiveDistricts */] = political_1.doResponsiveDistricts(s, bLog);
-        s.tests[15 /* EfficiencyGap */] = political_1.doEfficiencyGap(s, bLog);
-        s.tests[16 /* MajorityMinorityDistricts */] = minority_1.doMajorityMinorityDistricts(s, bLog);
-    }
-    // Tests in the "Best" suite, i.e., criteria for better/worse
-    if (requestedSuites.includes(2 /* Best */)) {
-        s.tests[5 /* Reock */] = compact_1.doReock(s, bLog);
-        s.tests[6 /* PolsbyPopper */] = compact_1.doPolsbyPopper(s, bLog);
         s.tests[7 /* UnexpectedCountySplits */] = cohesive_1.doFindCountiesSplitUnexpectedly(s, bLog);
         s.tests[10 /* VTDSplits */] = cohesive_1.doFindSplitVTDs(s, bLog);
-        s.tests[8 /* CountySplitting */] = cohesive_1.doCountySplitting(s, bLog);
-        s.tests[9 /* DistrictSplitting */] = cohesive_1.doDistrictSplitting(s, bLog);
     }
     // Enable a Test Log and Scorecard to be generated
     s.bPlanAnalyzed = true;
@@ -975,8 +1000,6 @@ exports.doAnalyzePlan = doAnalyzePlan;
 // NOTE - Should this be conditionalized on the test suites requested? 
 //   Those are encapsulated in reports.ts right now, so not doing that.
 function doDeriveSecondaryTests(s, bLog = false) {
-    // TODO - SCORE: Toggle
-    // const bLegacy = s._bLegacy;
     s.tests[3 /* EqualPopulation */] = equal_1.doHasEqualPopulations(s, bLog);
 }
 exports.doDeriveSecondaryTests = doDeriveSecondaryTests;
@@ -1596,18 +1619,11 @@ exports.doPopulationDeviation = doPopulationDeviation;
 // NOTE - This validity check is *derived* and depends on population deviation %
 //   being computed (above) and normalized in test log & scorecard generation.
 function doHasEqualPopulations(s, bLog = false) {
-    // TODO - SCORE: Toggle
-    // const bLegacy = s._bLegacy;
-    const scorecard = s._scorecard;
-    const popDevNormalizedNEW = scorecard.best.populationDeviation.normalized;
-    const bScore = (popDevNormalizedNEW > 0) ? true : false;
-    // TODO - Get scales
-    // TODO - Flow through to RequirementsChecklist
     let test = s.getTest(3 /* EqualPopulation */);
     // Get the normalized population deviation %
     let popDevTest = s.getTest(4 /* PopulationDeviation */);
-    let popDevPct = popDevTest['score'];
-    let popDevNormalized = popDevTest['normalizedScore'];
+    const popDevPct = popDevTest['score'];
+    const popDevNormalized = popDevTest['normalizedScore'];
     // Populate the test entry
     if (popDevNormalized > 0) {
         test['score'] = true;
@@ -1617,7 +1633,6 @@ function doHasEqualPopulations(s, bLog = false) {
     }
     test['details']['deviation'] = popDevPct;
     test['details']['thresholds'] = popDevTest['details']['scale'];
-    console.log("Equal population =", test['score'], bScore);
     // Populate the N+1 summary "district" in district.statistics
     let bEqualPop = s.districts.statistics[D.DistrictField.bEqualPop];
     let summaryRow = s.districts.numberOfRows() - 1;
@@ -2236,12 +2251,14 @@ function prepareRequirementsChecklist(s, bLog = false) {
         const emptyDistrictsDetail = U.deepCopy(completeTest['details']['emptyDistricts']) || [];
         const discontiguousDistrictsDetail = U.deepCopy(contiguousTest['details']['discontiguousDistricts']) || [];
         const embeddedDistrictsDetail = U.deepCopy(freeOfHolesTest['details']['embeddedDistricts']) || [];
-        const scorecard = s._scorecard;
-        const deviationThreshold = scorecard.best.populationDeviation.notes['threshold'];
-        // TODO - SCORE: Toggle
+        // TODO - SCORE: DELETE - This code is hooked correctly to use dra-score
+        // const scorecard = s._scorecard as Score.Scorecard;
+        // const populationDeviation = scorecard.best.populationDeviation.raw;
         const populationDeviationDetail = U.deepCopy(equalPopulationTest['details']['deviation']);
+        // console.log("Population deviations =", populationDeviationDetail, populationDeviation);
+        // const deviationThreshold = scorecard.best.populationDeviation.notes['threshold'];
         const deviationThresholdDetail = U.trim(s.populationDeviationThreshold());
-        console.log("Population deviation thresholds =", deviationThresholdDetail, deviationThreshold);
+        // console.log("Population deviation thresholds =", deviationThresholdDetail, deviationThreshold);
         const xx = s.state.xx;
         // TODO - JSON: Is there a better / easier way to work with the variable?
         const stateReqsDict = state_reqs_json_1.default;
@@ -2509,20 +2526,27 @@ exports.doConfigureScales = doConfigureScales;
 // Do this after analytics have been run and before preparing a test log or scorecard. 
 function doAnalyzePostProcessing(s, bLog = false) {
     // TODO - SCORE: Toggle
-    // const bLegacy = s._bLegacy;
-    // Normalize the raw scores for all the numerics tests
-    let testResults = U.getNumericObjectKeys(testDefns);
-    for (let testID of testResults) {
-        if (testDefns[testID]['normalize']) {
-            let testResult = s.getTest(testID);
-            let rawScore = testResult['score'];
-            let normalizedScore;
-            normalizedScore = U.normalize(rawScore, s.testScales[testID]);
-            testResult['normalizedScore'] = normalizedScore;
-            // Add the scale used to normalize the raw score to the details
-            testResult['details']['scale'] = s.testScales[testID].scale;
+    if (s.useLegacy()) {
+        // Normalize the raw scores for all the numerics tests
+        let testResults = U.getNumericObjectKeys(testDefns);
+        for (let testID of testResults) {
+            if (testDefns[testID]['normalize']) {
+                let testResult = s.getTest(testID);
+                let rawScore = testResult['score'];
+                let normalizedScore;
+                normalizedScore = U.normalize(rawScore, s.testScales[testID]);
+                testResult['normalizedScore'] = normalizedScore;
+                // Add the scale used to normalize the raw score to the details
+                testResult['details']['scale'] = s.testScales[testID].scale;
+            }
         }
     }
+    else {
+        // Just populate the normalized population deviation score in the test
+        const scorecard = s._scorecard;
+        let test = s.getTest(4 /* PopulationDeviation */);
+        test['normalizedScore'] = scorecard.best.populationDeviation.normalized;
+    }
     // Derive secondary tests
     analyze_1.doDeriveSecondaryTests(s, bLog);
     // Toggle the semaphore, so postprocessing isn't for both the testlog & scorecard
@@ -2643,9 +2667,27 @@ function makeArrayOfDemographics(s, bLog = false) {
     return demographicsArray;
 }
 // SCORE A PLAN
-function scorePlan(p, bLog = false) {
+function scorePlan(s, p, bLog = false, overridesJSON) {
     let scorer = new Score.Scorer();
-    return scorer.score(p);
+    const scorecard = scorer.score(p, overridesJSON);
+    // TODO - SCORE: Toggle: Before returning, create a dummy population deviation
+    //   test, for doHasEqualPopulations() to use later. This is preserving the old
+    //   calling sequence.
+    let test = s.getTest(4 /* PopulationDeviation */);
+    // TODO - SCORE: U.trim(popDev)???
+    // Get the raw population deviation
+    const popDev = scorecard.best.populationDeviation.raw;
+    // Populate the test entry
+    test['score'] = popDev;
+    test['details'] = { 'maxDeviation': scorecard.best.populationDeviation.notes['maxDeviation'] };
+    // Populate the N+1 summary "district" in district.statistics
+    let totalPop = s.districts.statistics[D.DistrictField.TotalPop];
+    let popDevPct = s.districts.statistics[D.DistrictField.PopDevPct];
+    let summaryRow = s.districts.numberOfRows() - 1;
+    totalPop[summaryRow] = p.populationProfile.targetSize;
+    popDevPct[summaryRow] = popDev;
+    //
+    return scorecard;
 }
 exports.scorePlan = scorePlan;