@dra2020/district-analytics 3.3.0 → 4.2.0

package/dist/district-analytics.js

@@ -1375,6 +1375,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Poly = __importStar(__webpack_require__(/*! @dra2020/poly */ "@dra2020/poly"));
 const geofeature_1 = __webpack_require__(/*! ./geofeature */ "./src/geofeature.ts");
 const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
+// TODO - SCORE: Remove legacy code
 // Measures of compactness compare district shapes to various ideally compact
 // benchmarks, such as circles. All else equal, more compact districts are better.
 // 
@@ -1670,6 +1671,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Poly = __importStar(__webpack_require__(/*! @dra2020/poly */ "@dra2020/poly"));
+// TODO - SCORE: Remove legacy code
 // HELPER
 function polyParts(poly) {
     let parts = { type: 'FeatureCollection', features: [] };
@@ -1823,6 +1825,7 @@ __export(__webpack_require__(/*! ./types */ "./src/types.ts"));
 // PROTECTS MINORITIES
 //
 Object.defineProperty(exports, "__esModule", { value: true });
+// TODO - SCORE: Remove legacy code
 function doMajorityMinorityDistricts(s, bLog = false) {
     let test = s.getTest(16 /* MajorityMinorityDistricts */);
     if (bLog)
@@ -1861,6 +1864,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const assert_1 = __webpack_require__(/*! assert */ "assert");
 const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
 const D = __importStar(__webpack_require__(/*! ./_data */ "./src/_data.ts"));
+// TODO - SCORE: Remove legacy code
 // Partisan analytics need the following data:
 //
 // An "election model" by geo_id, where each item has 4 pieces of data:
@@ -2117,116 +2121,238 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 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"));
 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
-// TODO - DELETE?
-let sampleRequirements = {
-    score: 2 /* Red */,
-    metrics: {
-        complete: 0 /* Green */,
-        contiguous: 2 /* Red */,
-        freeOfHoles: 1 /* Yellow */,
-        equalPopulation: 2 /* Red */
-    },
-    details: {
-        unassignedFeatures: [],
-        emptyDistricts: [],
-        discontiguousDistricts: [2],
-        embeddedDistricts: [],
-        populationDeviation: 0.6748,
-        deviationThreshold: 0.75 / 100
-    },
-    datasets: {
-        census: "2010 Census Total Population"
-    },
-    resources: {
-        stateReqs: "https://www.brennancenter.org/sites/default/files/publications/2019_06_50States_FINALsinglepages_20.pdf"
-    }
+// PLAN ANALYTICS
+/* TODO - DELETE
+export type RequirementsCategory = {
+  score: T.TriState;
+  metrics: {
+    complete: T.TriState;
+    contiguous: T.TriState;
+    freeOfHoles: T.TriState;
+    equalPopulation: T.TriState;
+  };
+  details: {
+    unassignedFeatures: string[];         // A possibly empty list of GEOIDs
+    emptyDistricts: number[];             // A possibly empty list of district IDs
+    discontiguousDistricts: number[];     // Ditto
+    embeddedDistricts: number[];          // Ditto
+    populationDeviation: number;          // A fraction [0.0 – 1.0] to represent as a %
+    deviationThreshold: number;           // A fraction [0.0 – 1.0] to represent as a %
+  };
+  datasets: T.Datasets;
+  resources: {
+    stateReqs: string;
+  };
 };
-// TODO - DELETE
-let sampleCompactness = {
-    score: 60,
-    metrics: {
-        reock: 0.3773,
-        polsby: 0.3815
-    },
-    details: {},
-    datasets: {
-        shapes: "2010 VTD shapes"
-    },
-    resources: {}
-};
-// TODO - DELETE
-let sampleSplitting = {
-    score: 73,
-    metrics: {
-        sqEnt_DCreduced: 1.531,
-        sqEnt_CDreduced: 1.760
-    },
-    details: {
-        countiesSplitUnexpectedly: [
-            "Bladen", "Buncombe", "Catawba", "Cumberland", "Durham", "Guilford", "Iredell", "Johnston", "Pitt", "Rowan", "Wilson"
-        ],
-        unexpectedAffected: 0.3096,
-        nSplitVTDs: 12,
-        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 - DELETE
+export type CompactnessCategory = {
+  score: number;                          // An integer score [0–100]
+  metrics: {
+    reock: number;                        // A decimal number [0.0–1.0]
+    polsby: number;                       // A decimal number [0.0–1.0]
+  };
+  details: {
+    // None at this time
+  };
+  datasets: T.Datasets;
+  resources: {
+    // None at this time
+  };
 };
-// TODO - DELETE
-let samplePartisan = {
-    score: 100,
-    metrics: {
-        partisanBias: 0.15,
-        responsiveness: 2.0
-    },
-    details: {},
-    datasets: {
-        election: "2016 Presidential, US Senate, Governor, and AG election results"
-    },
-    resources: {
-        planScore: "https://planscore.org/plan.html?20180219T202039.596761160Z"
-    }
+*/
+/* TODO - DELETE
+export type SplittingCategory = {
+  score: number;                          // An integer score [0–100]
+  metrics: {
+    sqEnt_DCreduced: number,              // A decimal number [1.0 – < 2.0]
+    sqEnt_CDreduced: number               // A decimal number [1.0 – < 2.0]
+  };
+  details: {
+    countiesSplitUnexpectedly: string[],  // A possibly empty list of county names
+    unexpectedAffected: number,           // A fraction [0.0 – 1.0] to represent as a %
+    nSplitVTDs: number,                   // An integer, possibly 0
+    splitVTDs: string[]                   // A possibly empty list of GEOIDs
+  };
+  datasets: T.Datasets;
+  resources: {
+    // None at this time
+  };
 };
-// TODO - DELETE
-let sampleMinority = {
-    score: null,
-    metrics: {
-        nBlack37to50: 1,
-        nBlackMajority: 12,
-        nHispanic37to50: 0,
-        nHispanicMajority: 0,
-        nPacific37to50: 0,
-        nPacificMajority: 0,
-        nAsian37to50: 0,
-        nAsianMajority: 0,
-        nNative37to50: 0,
-        nNativeMajority: 0,
-        nMinority37to50: 0,
-        nMinorityMajority: 0,
-        averageDVoteShare: 0.90
-    },
-    details: {
-        vap: true,
-        comboCategories: true
-    },
-    datasets: {
-        vap: "2010 Voting Age Population"
-    },
-    resources: {}
+*/
+/* TODO - DELETE
+export type PartisanCategory = {
+  score: number;                          // An integer score [0–100]
+  metrics: {
+    partisanBias: 0.15,                   // TBD
+    responsiveness: 2.0                   // TBD
+  };
+  details: {
+    // TODO - Need to flesh this out
+  };
+  datasets: T.Datasets;
+  resources: {
+    planScore?: string;
+  };
 };
-// TODO - DELETE
-exports.samplePlanAnalytics = {
-    requirements: sampleRequirements,
-    compactness: sampleCompactness,
-    // TODO - Don't show these categories yet
-    splitting: sampleSplitting,
-    partisan: samplePartisan,
-    minority: sampleMinority
+*/
+/* TODO - DELETE
+export type MinorityCategory = {
+  score: null;                            // Explicitly NOT scored
+  metrics: {
+    nBlack37to50: number,                 // Integer >= 0; two-digit maximum
+    nBlackMajority: number,               // Ditto
+    nHispanic37to50: number,              // Ditto
+    nHispanicMajority: number,            // Ditto
+    nPacific37to50: number,               // Ditto
+    nPacificMajority: number,             // Ditto
+    nAsian37to50: number,                 // Ditto
+    nAsianMajority: number,               // Ditto
+    nNative37to50: number,                // Ditto
+    nNativeMajority: number,              // Ditto
+    nMinority37to50: number,              // Ditto
+    nMinorityMajority: number,            // Ditto
+
+    averageDVoteShare: number             // A fraction [0.0 – 1.0] to represent as a %
+  };
+  details: {
+    vap: true,                            // true = using VAP data; false = CVAP data
+    comboCategories: true                 // true = using combo fields; false = mutually exclusive
+  };
+  datasets: T.Datasets;
+  resources: {
+    // TODO - Add these ...
+  };
 };
+*/
+/* TODO - DELETE
+export type PlanAnalytics = {
+  requirements: RequirementsCategory;
+  compactness: CompactnessCategory;
+  // TODO - Don't show these categories yet
+  splitting: SplittingCategory;
+  partisan: PartisanCategory;
+  minority: MinorityCategory;
+}
+*/
+// EXAMPLE
+/* TODO - DELETE
+let sampleRequirements: RequirementsCategory = {
+  score: T.TriState.Red,
+  metrics: {
+    complete: T.TriState.Green,
+    contiguous: T.TriState.Red,
+    freeOfHoles: T.TriState.Yellow,
+    equalPopulation: T.TriState.Red
+  },
+  details: {
+    unassignedFeatures: [],
+    emptyDistricts: [],
+    discontiguousDistricts: [2],
+    embeddedDistricts: [],
+    populationDeviation: 0.6748,
+    deviationThreshold: 0.75 / 100
+  },
+  datasets: {
+    census: "2010 Census Total Population"
+  },
+  resources: {
+    stateReqs: "https://www.brennancenter.org/sites/default/files/publications/2019_06_50States_FINALsinglepages_20.pdf"
+  }
+}
+*/
+/* TODO - DELETE
+let sampleCompactness: CompactnessCategory = {
+  score: 60,
+  metrics: {
+    reock: 0.3773,
+    polsby: 0.3815
+  },
+  details: {},
+  datasets: {
+    shapes: "2010 VTD shapes"
+  },
+  resources: {}
+}
+*/
+/* TODO - DELETE
+let sampleSplitting: SplittingCategory = {
+  score: 73,
+  metrics: {
+    sqEnt_DCreduced: 1.531,
+    sqEnt_CDreduced: 1.760
+  },
+  details: {
+    countiesSplitUnexpectedly: [
+      "Bladen", "Buncombe", "Catawba", "Cumberland", "Durham", "Guilford", "Iredell", "Johnston", "Pitt", "Rowan", "Wilson"
+    ],
+    unexpectedAffected: 0.3096,
+    nSplitVTDs: 12,
+    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 - DELETE
+let samplePartisan: PartisanCategory = {
+  score: 100,
+  metrics: {
+    partisanBias: 0.15,
+    responsiveness: 2.0
+  },
+  details: {},
+  datasets: {
+    election: "2016 Presidential, US Senate, Governor, and AG election results"
+  },
+  resources: {
+    planScore: "https://planscore.org/plan.html?20180219T202039.596761160Z"
+  }
+}
+*/
+/* TODO - DELETE
+let sampleMinority: MinorityCategory = {
+  score: null,
+  metrics: {
+    nBlack37to50: 1,
+    nBlackMajority: 12,
+    nHispanic37to50: 0,
+    nHispanicMajority: 0,
+    nPacific37to50: 0,
+    nPacificMajority: 0,
+    nAsian37to50: 0,
+    nAsianMajority: 0,
+    nNative37to50: 0,
+    nNativeMajority: 0,
+    nMinority37to50: 0,
+    nMinorityMajority: 0,
+
+    averageDVoteShare: 0.90
+  },
+  details: {
+    vap: true,
+    comboCategories: true
+  },
+  datasets: {
+    vap: "2010 Voting Age Population"
+  },
+  resources: {}
+}
+*/
+/* TODO - DELETE
+export const samplePlanAnalytics: PlanAnalytics = {
+  requirements: sampleRequirements,
+  compactness: sampleCompactness,
+  // TODO - Don't show these categories yet
+  splitting: sampleSplitting,
+  partisan: samplePartisan,
+  minority: sampleMinority
+}
+*/
 function prepareRequirementsChecklist(s, bLog = false) {
     if (!(s.bPostProcessingDone)) {
         doAnalyzePostProcessing(s);
@@ -2359,7 +2485,7 @@ function prepareDistrictStatistics(s, bLog = false) {
     // None at this time
     };
     let dsDatasets = {
-        shapes: "2010 VTD shapes",
+        shapes: S.SHAPES,
         census: U.deepCopy(s.config['descriptions']['CENSUS']),
         vap: U.deepCopy(s.config['descriptions']['VAP']),
         election: U.deepCopy(s.config['descriptions']['ELECTION'])
@@ -2422,6 +2548,7 @@ const populationDeviationDefn = {
     externalType: TestType.Percentage,
     suites: [0 /* Legal */, 2 /* Best */] // Both so EqualPopulation can be assessed
 };
+// TODO - SCORE: Comment these out ...
 const reockDefn = {
     ID: 5 /* Reock */,
     name: "Reock",
@@ -2549,10 +2676,26 @@ function doAnalyzePostProcessing(s, bLog = false) {
     else {
         // Just populate the normalized population deviation score in the test
         const scorecard = s._scorecard;
-        let test = s.getTest(4 /* PopulationDeviation */);
-        test['normalizedScore'] = scorecard.traditionalPrinciples.populationDeviation.normalized;
+        let popDev = s.getTest(4 /* PopulationDeviation */);
+        popDev['normalizedScore'] = scorecard.traditionalPrinciples.populationDeviation.normalized;
         // TODO - DELETE
         // test['normalizedScore'] = scorecard.best.populationDeviation.normalized;
+        // TODO - SCORE: Add datasets used to details by tab
+        const datasets = {
+            shapes: S.SHAPES,
+            census: U.deepCopy(s.config['descriptions']['CENSUS']),
+            vap: U.deepCopy(s.config['descriptions']['VAP']),
+            election: U.deepCopy(s.config['descriptions']['ELECTION'])
+        };
+        scorecard.partisan.details['election'] = datasets.election;
+        scorecard.minority.details['vap'] = datasets.vap;
+        scorecard.traditionalPrinciples.details['shapes'] = datasets.shapes;
+        scorecard.traditionalPrinciples.details['census'] = datasets.census;
+        // TODO - SCORE: Add legacy splits details
+        const simpleSplits = s.getTest(7 /* UnexpectedCountySplits */);
+        scorecard.traditionalPrinciples.details['unexpectedAffected'] = simpleSplits['score'];
+        scorecard.traditionalPrinciples.details['countiesSplitUnexpectedly'] = U.deepCopy(simpleSplits['details']['countiesSplitUnexpectedly']);
+        // NOTE - Add split precincts in dra-client directly
     }
     // Derive secondary tests
     analyze_1.doDeriveSecondaryTests(s, bLog);
@@ -2600,7 +2743,8 @@ function profilePlan(s, bLog = false) {
     const summaryRow = s.districts.numberOfRows() - 1;
     const statewideVf = U.trim(s.districts.statistics[D.DistrictField.DemPct][summaryRow], 6);
     const vpiArray = U.deepCopy(s.districts.statistics[D.DistrictField.DemPct].slice(1, -1));
-    const demographicsByDistrict = makeArrayOfDemographics(s);
+    const statewideDemographics = getStatewideDemographics(s);
+    const demographicsByDistrict = getDemographicsByDistrict(s);
     const profile = {
         state: state,
         planName: planName,
@@ -2608,21 +2752,22 @@ function profilePlan(s, bLog = false) {
         nCounties: nCounties,
         legislativeDistricts: s.legislativeDistricts,
         populationProfile: {
-            TotalPopByDistrict: popByDistrict,
+            totalPopByDistrict: popByDistrict,
             targetSize: targetSize
         },
         compactnessProfile: {
-            GeometryByDistrict: geoPropsByDistrict
+            geometryByDistrict: geoPropsByDistrict
         },
         splittingProfile: {
-            CountyPopByDistrict: splits
+            countyPopByDistrict: splits
         },
         partisanProfile: {
             statewideVf: statewideVf,
-            VfArray: vpiArray
+            vfArray: vpiArray
         },
         demographicProfile: {
-            DemographicsByDistrict: demographicsByDistrict
+            stateMfArray: statewideDemographics,
+            mfArrayByDistrict: demographicsByDistrict
         }
     };
     return profile;
@@ -2656,7 +2801,7 @@ function makeArrayOfGeoProps(s, bLog = false) {
     }
     return geometryByDistrict;
 }
-function makeArrayOfDemographics(s, bLog = false) {
+function getDemographicsByDistrict(s, bLog = false) {
     let demographicsArray = [];
     // Remove the unassigned & total dummy "districts"
     for (let districtID = 1; districtID <= s.state.nDistricts; districtID++) {
@@ -2673,6 +2818,19 @@ function makeArrayOfDemographics(s, bLog = false) {
     }
     return demographicsArray;
 }
+function getStatewideDemographics(s, bLog = false) {
+    const summaryRow = s.districts.numberOfRows() - 1;
+    const demographicsArray = [
+        U.deepCopy(s.districts.statistics[D.DistrictField.WhitePct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.MinorityPct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.BlackPct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.HispanicPct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.PacificPct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.AsianPct][summaryRow]),
+        U.deepCopy(s.districts.statistics[D.DistrictField.NativePct][summaryRow])
+    ];
+    return demographicsArray;
+}
 // SCORE A PLAN
 function scorePlan(s, p, bLog = false, overridesJSON) {
     let scorer = new Score.Scorer();
@@ -2735,6 +2893,8 @@ exports.EQUAL_TOLERANCE = AVERAGE_BLOCK_SIZE / 2;
 // County & district splitting weights
 exports.COUNTY_SPLITTING_WEIGHT = 0.8;
 exports.DISTRICT_SPLITTING_WEIGHT = 1.0 - exports.COUNTY_SPLITTING_WEIGHT;
+// TODO - 2020
+exports.SHAPES = "2010 VTD shapes";
 
 
 /***/ }),