@dra2020/district-analytics 1.0.4 → 1.0.7

package/lib/report.js

@@ -0,0 +1,817 @@
+"use strict";
+//
+// GENERATE REPORTS
+// - A test log: a simple enumeration of all analytics & validations w/ raw results
+// - A scorecard: a structured subset of analytics & validations w/ normalized
+//   results, cateories, and an overall score
+// 
+Object.defineProperty(exports, "__esModule", { value: true });
+const U = require("./utils");
+const S = require("./settings");
+const D = require("./_data");
+const analyze_1 = require("./analyze");
+// TEST META-DATA
+var TestType;
+(function (TestType) {
+    TestType[TestType["PassFail"] = 0] = "PassFail";
+    TestType[TestType["Percentage"] = 1] = "Percentage";
+    TestType[TestType["Number"] = 2] = "Number";
+})(TestType || (TestType = {}));
+const completeDefn = {
+    ID: 0 /* Complete */,
+    name: "Complete",
+    normalize: false,
+    externalType: TestType.PassFail,
+    detailsFn: doPrepareCompleteDetails,
+    suites: [0 /* Legal */]
+};
+const contiguousDefn = {
+    ID: 1 /* Contiguous */,
+    name: "Contiguous",
+    normalize: false,
+    externalType: TestType.PassFail,
+    detailsFn: doPrepareContiguousDetails,
+    suites: [0 /* Legal */]
+};
+const freeOfHolesDefn = {
+    ID: 2 /* FreeOfHoles */,
+    name: "Free of Holes",
+    normalize: false,
+    externalType: TestType.PassFail,
+    detailsFn: doPrepareFreeOfHolesDetails,
+    suites: [0 /* Legal */]
+};
+const equalPopulationDefn = {
+    ID: 3 /* EqualPopulation */,
+    name: "Equal Population",
+    normalize: false,
+    externalType: TestType.PassFail,
+    detailsFn: doPrepareEqualPopulationDetails,
+    suites: [0 /* Legal */]
+};
+const populationDeviationDefn = {
+    ID: 4 /* PopulationDeviation */,
+    name: "Population Deviation",
+    normalize: true,
+    externalType: TestType.Percentage,
+    detailsFn: doPreparePopulationDeviationDetails,
+    suites: [0 /* Legal */, 2 /* Best */] // Both so EqualPopulation can be assessed
+};
+const reockDefn = {
+    ID: 5 /* Reock */,
+    name: "Reock",
+    normalize: true,
+    externalType: TestType.Number,
+    detailsFn: doPrepareReockDetails,
+    suites: [2 /* Best */]
+};
+const polsbyPopperDefn = {
+    ID: 6 /* PolsbyPopper */,
+    name: "Polsby-Popper",
+    normalize: true,
+    externalType: TestType.Number,
+    detailsFn: doPreparePolsbyPopperDetails,
+    suites: [2 /* Best */]
+};
+const countySplitsDefn = {
+    ID: 7 /* CountySplits */,
+    name: "County splits",
+    trailer: "of the population had their county split unexpectedly.",
+    normalize: true,
+    externalType: TestType.Percentage,
+    detailsFn: doPrepareCountySplitDetails,
+    suites: [2 /* Best */]
+};
+const efficiencyGapDefn = {
+    ID: 13 /* EfficiencyGap */,
+    name: "Efficiency Gap",
+    normalize: false,
+    externalType: TestType.Percentage,
+    detailsFn: doPrepareEfficiencyGapDetails,
+    suites: [1 /* Fair */]
+};
+// All the tests that have been defined (can be reported on)
+const testDefns = {
+    [0 /* Complete */]: completeDefn,
+    [1 /* Contiguous */]: contiguousDefn,
+    [2 /* FreeOfHoles */]: freeOfHolesDefn,
+    [3 /* EqualPopulation */]: equalPopulationDefn,
+    [4 /* PopulationDeviation */]: populationDeviationDefn,
+    [5 /* Reock */]: reockDefn,
+    [6 /* PolsbyPopper */]: polsbyPopperDefn,
+    [7 /* CountySplits */]: countySplitsDefn,
+    [13 /* EfficiencyGap */]: efficiencyGapDefn
+    /* TODO - More tests ... */
+};
+// Scorecard category definitions
+const validCategory = {
+    catName: "Valid",
+    catTests: [
+        { testID: 0 /* Complete */ },
+        { testID: 1 /* Contiguous */ },
+        { testID: 2 /* FreeOfHoles */ },
+        { testID: 3 /* EqualPopulation */ }
+    ],
+    catNumeric: false,
+    catWeight: undefined,
+    catPrepareFn: doPrepareValidSection
+};
+const fairCategory = {
+    catName: "Fair",
+    catTests: [
+        {
+            testID: 13 /* EfficiencyGap */,
+            testWeight: 100
+        }
+    ],
+    catNumeric: true,
+    catWeight: undefined,
+    catPrepareFn: doPrepareFairSection
+};
+// TODO - Decide on the relative weights of these tests!
+// NOTE: 'testWeights' are simply relative, i.e., each normalized score is
+//   multiplied by the associated 'testWeight', and the sum of those is divided
+//   by the total weight. Weights don't have to add to 100.
+const bestCategory = {
+    catName: "Best",
+    catTests: [
+        {
+            testID: 4 /* PopulationDeviation */,
+            testWeight: 10
+        },
+        {
+            testID: 5 /* Reock */,
+            testWeight: 25
+        },
+        {
+            testID: 6 /* PolsbyPopper */,
+            testWeight: 25
+        },
+        {
+            testID: 7 /* CountySplits */,
+            testWeight: 50
+        }
+    ],
+    catNumeric: true,
+    catWeight: undefined,
+    catPrepareFn: doPrepareBestSection
+};
+// The overall scorecard definition
+const scorecardDefn = {
+    [0 /* Legal */]: validCategory,
+    // TODO - NIY
+    // [T.Suite.Fair]: fairCategory,
+    [2 /* Best */]: bestCategory
+};
+// NORMALIZE RAW ANALYTICS
+//   Raw numeric analytics, such as population deviation, compactness, etc. are
+//   normalized as part of creating a scorecard, so the code to normalize results
+//   is encapsulated here.
+// Configure scale parameters for normalizing each raw test result
+//   This needs to be separate from the scorecard configuration info above,
+//   because some scales need access to the analytics session object.
+function doConfigureScales(s) {
+    // Scale defn for PopulationDeviation
+    const CDLimit = 0.75 / 100; // Deviation threshold for CD's
+    const LDLimit = 10.00 / 100; // Deviation threshold for LD's
+    const CDGoodEnough = 0.20 / 100;
+    const LDGoodEnough = (CDGoodEnough / CDLimit) * LDLimit;
+    const scale = (s.legislativeDistricts) ? [1.0 - LDLimit, 1.0 - LDGoodEnough] : [1.0 - CDLimit, 1.0 - CDGoodEnough];
+    // const scale = [1.0 - CDLimit, 1.0 - CDGoodEnough];
+    s.testScales[4 /* PopulationDeviation */] = { testScale: scale, testInvertp: true };
+    s.testScales[5 /* Reock */] = { testScale: [0.25, 0.50], testInvertp: false };
+    s.testScales[6 /* PolsbyPopper */] = { testScale: [0.10, 0.50], testInvertp: false };
+    const SPLITLimit = 0.1; // TODO - Just a placeholder default maximum (10%)
+    s.testScales[7 /* CountySplits */] = { testScale: [1.0 - SPLITLimit, 1.0], testInvertp: true };
+    // TODO - More analytics ...
+}
+exports.doConfigureScales = doConfigureScales;
+// Postprocess analytics - Normalize numeric results and derive secondary tests.
+// Do this after analytics have been run and before preparing a test log or scorecard. 
+function doAnalyzePostProcessing(s) {
+    // 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;
+            let { testScale, testInvertp } = s.testScales[testID];
+            normalizedScore = U.normalize(rawScore, testScale, testInvertp);
+            testResult['normalizedScore'] = normalizedScore;
+            // Add the scale used to normalize the raw score to the details
+            testResult['details']['scale'] = testScale;
+        }
+    }
+    // Derive secondary tests
+    analyze_1.doDeriveSecondaryTests(s);
+    // Toggle the semaphore, so postprocessing isn't for both the testlog & scorecard
+    s.bPostProcessingDone = true;
+}
+exports.doAnalyzePostProcessing = doAnalyzePostProcessing;
+// Prepare a structured but unformatted scorecard, from the test results
+function doGenerateScorecard(s) {
+    if (!(s.bPostProcessingDone)) {
+        doAnalyzePostProcessing(s);
+    }
+    // Create a new scorecard
+    let scorecard = {};
+    // Filter the defined scorecard categories by the requested test suites
+    let categories = U.getNumericObjectKeys(scorecardDefn);
+    let suitesRequested = s.config['suites'];
+    categories = categories.filter(x => suitesRequested.includes(x));
+    // ... and initialize each one in the new scorecard
+    for (let c of categories) {
+        scorecard[c] = {};
+        scorecard[c]['catName'] = scorecardDefn[c]['catName'];
+        scorecard[c]['catTests'] = {};
+        // scorecard[c]['catScore'] = undefined;
+    }
+    // For each scorecard category
+    for (let c of categories) {
+        // Grab the scorecard category definition
+        let { catName, catTests, catNumeric } = scorecardDefn[c];
+        let numericCategoryScore = 0;
+        let totalWeight = 0;
+        let booleanCategoryScore = true;
+        // Process the results for each test result in the category
+        for (let testDefn of catTests) {
+            // Get the config info for the test
+            let testID = testDefn['testID'];
+            // ... and the actual test result
+            let testResult = s.getTest(testID);
+            // Create a new test entry for the scorecard
+            let testReport = U.deepCopy(testResult);
+            // Add the name
+            testReport['name'] = testDefns[testID]['name'];
+            if (catNumeric) {
+                // Normalize raw numeric scores ... moved to FIRST PASS above
+                // Accumulate a category score
+                let normalizedScore = testReport['normalizedScore'];
+                numericCategoryScore += normalizedScore * testDefn['testWeight'];
+                totalWeight += testDefn['testWeight'];
+            }
+            else {
+                // AND together pass/fail tests into a category score
+                if (!testReport['score']) {
+                    booleanCategoryScore = false;
+                }
+            }
+            scorecard[c]['catTests'][testID] = testReport;
+        }
+        // Set the category score
+        if (catNumeric) {
+            scorecard[c]['catScore'] = Math.round(numericCategoryScore / totalWeight);
+        }
+        else {
+            scorecard[c]['catScore'] = booleanCategoryScore;
+        }
+    }
+    // TODO - Compute an overall score from the category weights
+    return scorecard;
+}
+// Prepare a formatted scorecard suitable for rendering
+function doPrepareScorecard(s) {
+    // Initialize the output format
+    let text = { data: [] };
+    let blocks = text.data;
+    // If the plan as already been analyzed, prepare a scorecard
+    if (s.bPlanAnalyzed) {
+        // Create and cache a new, unformatted scorecard
+        s.scorecard = doGenerateScorecard(s);
+        // Create a scorecard header
+        blocks.push({ variant: 'h4', text: `Analysis` });
+        // Report district statistics
+        blocks.push({ variant: 'h5', text: `Individual Districts` });
+        let districtStatisticsText = doPrepareDistrictStatistics(s);
+        blocks.push(...districtStatisticsText);
+        // Prepare each scorecard category
+        blocks.push({ variant: 'h5', text: `Overall Plan` });
+        let categories = U.getNumericObjectKeys(s.scorecard);
+        for (let c of categories) {
+            let sectionPrepareFn = scorecardDefn[c]['catPrepareFn'];
+            let sectionText = sectionPrepareFn(s, c);
+            blocks.push(...sectionText);
+        }
+        // Report what datasets were used
+        let c = s.config['datasets']["CENSUS" /* CENSUS */];
+        let v = s.config['datasets']["VAP" /* VAP */];
+        let e = s.config['datasets']["ELECTION" /* ELECTION */];
+        blocks.push({ variant: 'body1', text: `Using datasets:` });
+        blocks.push({ variant: 'body1', text: `* ${c}: ${D.DatasetDescriptions[c]}` });
+        blocks.push({ variant: 'body1', text: `* ${v}: ${D.DatasetDescriptions[v]}` });
+        blocks.push({ variant: 'body1', text: `* ${e}: ${D.DatasetDescriptions[e]}` });
+    }
+    // Otherwise, return a blank scorecard
+    // TODO - What dra-client returns from renderAnalyzeCore()
+    // return <STV.StaticTextView text={ text } />;
+    return text;
+}
+exports.doPrepareScorecard = doPrepareScorecard;
+function doPrepareDistrictStatistics(s) {
+    let text = { data: [] };
+    let blocks = text.data;
+    blocks.push({ variant: 'beginTable' });
+    blocks.push({ variant: 'row', cells: ['ID', 'Total', 'Δ%', 'OK?', '*', 'Dem', 'Rep', 'White', 'Minority', 'Black', 'Hispanic', 'Pacific', 'Asian', 'Native'] });
+    for (let d = 0; d < s.districts.numberOfRows(); d++) {
+        let tot = s.districts.statistics[D.DistrictField.TotalPop][d];
+        if (tot == 0)
+            blocks.push({ variant: 'row', cells: [String(d), '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-'] });
+        else {
+            tot = Math.round(tot);
+            let dev = fractionToPercentage(s.districts.statistics[D.DistrictField.PopDevPct][d]);
+            let bEq = true; // TODO - Set based on population threshold
+            let bC = s.districts.statistics[D.DistrictField.bContiguous][d]
+                && s.districts.statistics[D.DistrictField.bNotEmbedded][d];
+            let dPct = fractionToPercentage(s.districts.statistics[D.DistrictField.DemPct][d]);
+            let rPct = fractionToPercentage(s.districts.statistics[D.DistrictField.RepPct][d]);
+            let wPct = fractionToPercentage(s.districts.statistics[D.DistrictField.WhitePct][d]);
+            let mPct = fractionToPercentage(s.districts.statistics[D.DistrictField.MinorityPct][d]);
+            let bPct = fractionToPercentage(s.districts.statistics[D.DistrictField.BlackPct][d]);
+            let hPct = fractionToPercentage(s.districts.statistics[D.DistrictField.HispanicPct][d]);
+            let pPct = fractionToPercentage(s.districts.statistics[D.DistrictField.PacificPct][d]);
+            let aPct = fractionToPercentage(s.districts.statistics[D.DistrictField.AsianPct][d]);
+            let nPct = fractionToPercentage(s.districts.statistics[D.DistrictField.NativePct][d]);
+            let id;
+            if (d == 0)
+                id = "??";
+            else if (d == (s.districts.numberOfRows() - 1))
+                id = "  ";
+            else
+                id = String(d);
+            blocks.push({
+                variant: 'row',
+                cells: [
+                    `${id}`,
+                    `${formatInteger(tot)}`,
+                    `${formatPercentage(dev)}%`,
+                    `${pfBoolToString(bEq)}`,
+                    `${pfBoolToString(bC)}`,
+                    `${formatPercentage(dPct)}%`,
+                    `${formatPercentage(rPct)}%`,
+                    `${formatPercentage(wPct)}%`,
+                    `${formatPercentage(mPct)}%`,
+                    `${formatPercentage(bPct)}%`,
+                    `${formatPercentage(hPct)}%`,
+                    `${formatPercentage(pPct)}%`,
+                    `${formatPercentage(aPct)}%`,
+                    `${formatPercentage(nPct)}%`
+                ]
+            });
+        }
+    }
+    blocks.push({ variant: 'endTable' });
+    return blocks;
+}
+// TEST LOG
+// Prepare formatted test results for rendering
+function doPrepareTestLog(s) {
+    // Initialize the output format
+    let text = { data: [] };
+    let blocks = text.data;
+    // If the plan as already been analyzed, prepare a test log
+    if (s.bPlanAnalyzed) {
+        if (!(s.bPostProcessingDone)) {
+            doAnalyzePostProcessing(s);
+        }
+        // Create a test log header
+        blocks.push({ variant: 'h4', text: `Test Log` });
+        let testResults = U.getNumericObjectKeys(testDefns);
+        let suitesRequested = new Set(s.config['suites']);
+        for (let testID of testResults) {
+            // Filter the defined tests by the requested test suites
+            let inSuites = testDefns[testID]['suites'];
+            if (!(U.isArrayEmpty(inSuites.filter(x => suitesRequested.has(x))))) {
+                // Get the test result
+                let testResult = s.getTest(testID);
+                // Prepare the text for it, and append it to the output
+                let testText = prepareTestEntry(testID, testResult);
+                blocks.push(...testText);
+            }
+        }
+    }
+    // Otherwise, return a blank test log
+    // TODO - What dra-client returns from renderAnalyzeCore()
+    // return <STV.StaticTextView text={ text } />;
+    return text;
+}
+exports.doPrepareTestLog = doPrepareTestLog;
+function prepareTestEntry(testID, testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    let testName = testDefns[testID]['name'];
+    let testNameTrailer = "";
+    if (U.keyExists('trailer', testDefns[testID])) {
+        testNameTrailer = testDefns[testID]['trailer'];
+    }
+    let testType = testDefns[testID]['externalType'];
+    let bNormalize = testDefns[testID]['normalize'];
+    let detailsFn = testDefns[testID]['detailsFn'];
+    let detailsText = detailsFn(testResult);
+    let score; // NOTE - Won't be undefined here
+    let normalizedScore;
+    let scoreText;
+    // Get the score ...
+    score = testResult['score'];
+    // ... and format it for rendering
+    switch (testType) {
+        case TestType.PassFail: {
+            scoreText = pfBoolToString(score);
+            blocks.push({ variant: 'body1', text: `${testName}: ${scoreText} ${testNameTrailer}` });
+            break;
+        }
+        case TestType.Percentage: {
+            score = fractionToPercentage(score);
+            if (bNormalize) {
+                normalizedScore = testResult['normalizedScore'];
+                blocks.push({ variant: 'body1', text: `${testName}: ${normalizedScore} / 100 : ${formatPercentage(score)}% ${testNameTrailer}` });
+            }
+            else {
+                blocks.push({ variant: 'body1', text: `${testName}: ${formatPercentage(score)}% ${testNameTrailer}` });
+            }
+            break;
+        }
+        case TestType.Number: {
+            if (bNormalize) {
+                normalizedScore = testResult['normalizedScore'];
+                blocks.push({ variant: 'body1', text: `${testName}: ${normalizedScore} / 100 : ${formatNumber(score)} ${testNameTrailer}` });
+            }
+            else {
+                blocks.push({ variant: 'body1', text: `${testName}: ${formatNumber(score)} ${testNameTrailer}` });
+            }
+            break;
+        }
+        default: {
+            // Unknown test type
+            throw new RangeError();
+        }
+    }
+    // Add the details text
+    blocks.push(...detailsText);
+    return blocks;
+}
+// FORMATTERS FOR TEST DETAILS
+function doPrepareCompleteDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    if (!U.isObjectEmpty(testResult['details'])) {
+        let unassignedText = "";
+        let emptyText = "";
+        let missingText = "";
+        if (U.keyExists('unassignedFeatures', testResult['details'])) {
+            let unassignedFeatures = testResult['details']['unassignedFeatures'];
+            let unassignedList = prepareListItems(unassignedFeatures);
+            let unassignedTextTemplates = [
+                `GEOID ${unassignedList} is not assigned to a district.`,
+                `GEOIDs ${unassignedList} are not assigned to districts.`,
+                `Several GEOIDs are not assigned to districts, including ${unassignedList}.`
+            ];
+            unassignedText = prepareListText(unassignedFeatures, unassignedTextTemplates);
+        }
+        if (U.keyExists('emptyDistricts', testResult['details'])) {
+            let emptyDistricts = testResult['details']['emptyDistricts'];
+            let emptyList = prepareListItems(emptyDistricts);
+            let emptyTextTemplates = [
+                `District ${emptyList} is empty.`,
+                `Districts ${emptyList} are empty.`,
+                `Several districts are empty, including ${emptyList}.`
+            ];
+            emptyText = prepareListText(emptyDistricts, emptyTextTemplates);
+        }
+        if (U.keyExists('missingDistricts', testResult['details'])) {
+            missingText = `Not enough districts have been defined. `;
+        }
+        let detailsText = "  " + unassignedText + emptyText + missingText;
+        blocks.push({ variant: 'body1', text: detailsText });
+    }
+    return blocks;
+}
+function doPrepareContiguousDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    if (!U.isObjectEmpty(testResult['details'])) {
+        let discontiguousDistricts = testResult['details']['discontiguousDistricts'];
+        let discontiguousList = prepareListItems(discontiguousDistricts);
+        let discontiguousTextTemplates = [
+            `District ${discontiguousList} is not contiguous.`,
+            `Districts ${discontiguousList} are not contiguous.`,
+            `Several districts are not contiguous, including ${discontiguousList}.`
+        ];
+        let detailsText = prepareListText(discontiguousDistricts, discontiguousTextTemplates);
+        blocks.push({ variant: 'body1', text: detailsText });
+    }
+    return blocks;
+}
+function doPrepareFreeOfHolesDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    if (!U.isObjectEmpty(testResult['details'])) {
+        let embeddedDistricts = testResult['details']['embeddedDistricts'];
+        let embeddedList = prepareListItems(embeddedDistricts);
+        let embeddedTextTemplates = [
+            `District ${embeddedList} is fully embedded within another district.`,
+            `Both districts ${embeddedList} are fully embedded within other districts.`,
+            `Several districts are fully embedded within other districts, including ${embeddedList}.`
+        ];
+        let detailsText = prepareListText(embeddedDistricts, embeddedTextTemplates);
+        blocks.push({ variant: 'body1', text: detailsText });
+    }
+    return blocks;
+}
+function doPrepareEqualPopulationDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    if (!U.isObjectEmpty(testResult['details'])) {
+        let popDevPct = fractionToPercentage(testResult['details']['deviation']);
+        let thresholdPct = fractionToPercentage(1.0 - testResult['details']['thresholds'][0]);
+        let detailsText = '';
+        if (!(testResult['score'])) {
+            detailsText = `The ${formatPercentage(popDevPct)}% population deviation is greater than the ${formatPercentage(thresholdPct)}% threshold tolerated by courts.`;
+        }
+        blocks.push({ variant: 'body1', text: detailsText });
+    }
+    return blocks;
+}
+function doPreparePopulationDeviationDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    let n = Math.round(testResult['details']['maxDeviation']);
+    let term = "people";
+    if (n == 1) {
+        term = "person";
+    }
+    blocks.push({ variant: 'body1', text: `The maximum population deviation between districts is ${formatInteger(n)} ${term}.` });
+    return blocks;
+}
+function doPrepareReockDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    // TODO - No details implemented yet
+    return blocks;
+}
+function doPreparePolsbyPopperDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    // TODO - No details implemented yet
+    return blocks;
+}
+function doPrepareEfficiencyGapDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    // TODO - Not yet implemented
+    return blocks;
+}
+function doPrepareCountySplitDetails(testResult) {
+    let text = { data: [] };
+    let blocks = text.data;
+    let unexpectedAffected = fractionToPercentage(testResult['details']['unexpectedAffected']);
+    let affectedText = `affecting ${formatPercentage(unexpectedAffected)}% of the total population.`;
+    let countiesSplitUnexpectedly = testResult['details']['countiesSplitUnexpectedly'];
+    let nCountiesSplitUnexpectedly = countiesSplitUnexpectedly.length;
+    let nUnexpectedSplits = testResult['details']['unexpectedSplits'];
+    let splitList = prepareListItems(countiesSplitUnexpectedly);
+    let splitTextTemplates = [
+        `${splitList} county is split unexpectedly, `,
+        `${splitList} counties are split unexpectedly, `,
+        // `These ${formatInteger(nCountiesSplitUnexpectedly)} counties are split unexpectedly--${splitList}--`
+        `${splitList} counties are split unexpectedly ${formatInteger(nUnexpectedSplits)} times, `
+    ];
+    let detailsText = prepareListText(countiesSplitUnexpectedly, splitTextTemplates) + affectedText;
+    blocks.push({ variant: 'body1', text: detailsText });
+    return blocks;
+}
+// FORMATTERS FOR CATEGORIES
+// This function parses & formats the 'Valid' section of a scorecard.
+function doPrepareValidSection(s, c) {
+    // Get the category meta data
+    let { catName, catScore, catTests } = s.scorecard[c];
+    let testReport;
+    // Initialize the section text
+    let text = { data: [] };
+    let blocks = text.data;
+    let testText;
+    // Section header
+    let stringScore = pfBoolToString(catScore);
+    blocks.push({ variant: 'h6', text: `${catName}: ${stringScore}` });
+    // Complete
+    testReport = catTests[0 /* Complete */];
+    testText = prepareTestEntry(0 /* Complete */, testReport);
+    blocks.push(...testText);
+    // Contiguous
+    testReport = catTests[1 /* Contiguous */];
+    testText = prepareTestEntry(1 /* Contiguous */, testReport);
+    blocks.push(...testText);
+    // Free of holes (no embedded districts)
+    testReport = catTests[2 /* FreeOfHoles */];
+    testText = prepareTestEntry(2 /* FreeOfHoles */, testReport);
+    blocks.push(...testText);
+    // Equal population (w/in the appropriate legal threshold)
+    testReport = catTests[3 /* EqualPopulation */];
+    testText = prepareTestEntry(3 /* EqualPopulation */, testReport);
+    blocks.push(...testText);
+    return blocks;
+}
+// TODO - NIY
+// This function parses & formats the 'Fair' section of a scorecard.
+function doPrepareFairSection(s, c) {
+    // Get the category meta data
+    let { catName, catScore, catTests } = s.scorecard[c];
+    let testReport;
+    // Initialize the section text
+    let text = { data: [] };
+    let blocks = text.data;
+    let testText;
+    // Section header
+    blocks.push({ variant: 'h6', text: `${catName}: ${catScore}` });
+    // TODO - Flesh this out
+    // There's only one test: Population Deviation.
+    // testReport = catTests[T.Test.PopulationDeviation];
+    // testText = prepareTestEntry(T.Test.PopulationDeviation, testReport);
+    // blocks.push(...testText);
+    return blocks;
+}
+// This function parses & formats the 'Best' section of a scorecard.
+function doPrepareBestSection(s, c) {
+    // Get the category meta data
+    let { catName, catScore, catTests } = s.scorecard[c];
+    let testReport;
+    // Initialize the section text
+    let text = { data: [] };
+    let blocks = text.data;
+    let testText;
+    // Section header
+    blocks.push({ variant: 'h6', text: `${catName}: ${catScore}` });
+    // Population deviation
+    testReport = catTests[4 /* PopulationDeviation */];
+    testText = prepareTestEntry(4 /* PopulationDeviation */, testReport);
+    blocks.push(...testText);
+    // Compactness
+    testReport = catTests[5 /* Reock */];
+    let normalizedReock = testReport['normalizedScore'];
+    let reockTestText = prepareTestEntry(5 /* Reock */, testReport);
+    testReport = catTests[6 /* PolsbyPopper */];
+    let normalizedPolsbyPopper = testReport['normalizedScore'];
+    let polsbyPopperTestText = prepareTestEntry(6 /* PolsbyPopper */, testReport);
+    let compactnessScore = (normalizedReock + normalizedPolsbyPopper) / 2;
+    blocks.push({ variant: 'body1', text: `Compactness: ${compactnessScore} / 100` });
+    blocks.push(...reockTestText);
+    blocks.push(...polsbyPopperTestText);
+    // County splits
+    testReport = catTests[7 /* CountySplits */];
+    testText = prepareTestEntry(7 /* CountySplits */, testReport);
+    blocks.push(...testText);
+    return blocks;
+}
+// FORMATTING HELPERS
+// Convert a boolean representing Pass/Fail to a string
+function pfBoolToString(score) {
+    if (score) {
+        return "Yes";
+    }
+    else {
+        return "No";
+    }
+}
+function fractionToPercentage(f) {
+    return f * 100;
+}
+function formatNumber(n) {
+    let p = S.PRECISION;
+    return n.toLocaleString('en-US', { minimumFractionDigits: p, maximumFractionDigits: p });
+}
+function formatPercentage(n) {
+    let p = (S.PRECISION / 2);
+    return n.toLocaleString('en-US', { minimumFractionDigits: p, maximumFractionDigits: p });
+}
+function formatInteger(i) {
+    return new Intl.NumberFormat().format(i);
+}
+// Prepare the items in a list for rendering
+function prepareListItems(list) {
+    let nItems = list.length;
+    let listStr;
+    switch (nItems) {
+        case 1: {
+            listStr = list[0];
+            break;
+        }
+        case 2: {
+            listStr = list[0] + " and " + list[1];
+            break;
+        }
+        default: {
+            let listWithCommas = list.join(', ');
+            let lastCommaIndex = listWithCommas.length - ((list[list.length - 1].length) + 1);
+            let beforeAnd = listWithCommas.substr(0, lastCommaIndex);
+            let afterAnd = listWithCommas.substr(lastCommaIndex + 1);
+            listStr = beforeAnd + " and " + afterAnd;
+            break;
+        }
+    }
+    return listStr;
+}
+// Pick the rendering text for the appropriate list length
+function prepareListText(list, listTemplates) {
+    let nItems = list.length;
+    switch (nItems) {
+        case 1: {
+            return listTemplates[0];
+            break;
+        }
+        case 2: {
+            return listTemplates[1];
+            break;
+        }
+        default: {
+            return listTemplates[2];
+            break;
+        }
+    }
+}
+/* COMMAND-LINE TESTS
+
+node main.js scorecard -v -x NC -n 13 -p ~/src/district-analytics/data/SAMPLE-BG-map.csv -d ~/src/district-analytics/data/SAMPLE-BG-data2.json -s ~/src/district-analytics/data/SAMPLE-BG-shapes.geojson -g ~/src/district-analytics/data/SAMPLE-BG-graph.json -c ~/src/district-analytics/data/SAMPLE-COUNTY.geojson
+node --inspect --inspect-brk main.js scorecard -v -x NC -n 13 -p ~/src/district-analytics/data/SAMPLE-BG-map.csv -d ~/src/district-analytics/data/SAMPLE-BG-data2.json -s ~/src/district-analytics/data/SAMPLE-BG-shapes.geojson -g ~/src/district-analytics/data/SAMPLE-BG-graph.json -c ~/src/district-analytics/data/SAMPLE-COUNTY.geojson
+
+-or-
+
+./main.js scorecard -v -x NC -n 13 -p ../data/SAMPLE-BG-map.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+./main.js --inspect --inspect-brk scorecard -v -x NC -n 13 -p ../data/SAMPLE-BG-map.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+
+These calls work at the project directory, using samples in the data/ directory:
+
+./main.js testlog -v -x NC -n 13 -p ../data/SAMPLE-BG-map.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+
+TODO - Fix this
+./main.js testlog -v -x NC -n 13 -p ../data/SAMPLE-BG-map-missing.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+./main.js scorecard -v -x NC-n 13 -p ../data/SAMPLE-BG-map-missing.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -v -x NC -n 13 -p ../data/SAMPLE-BG-map-unassigned.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+./main.js scorecard -v -x NC -n 13 -p ../data/SAMPLE-BG-map-unassigned.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson
+
+TODO - HERE
+
+./main.js -v -x NC testlog -p ../data/SAMPLE-BG-map.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson --empty
+./main.js -v -x NC scorecard -p ../data/SAMPLE-BG-map.csv -d ../data/SAMPLE-BG-data2.json -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -c ../data/SAMPLE-COUNTY.geojson --empty
+
+TODO
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-discontiguous.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-discontiguous.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-hole.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-hole.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+node main.js scorecard -v -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+
+These calls test NC block-level data stored in my ~/data/redistricting-data/2010/compact/sample directory:
+
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-shapes.geojson -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/tl_2018_37_tabblock10.json -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+
+node main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-shapes.geojson -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+node main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/tl_2018_37_tabblock10.json -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+
+
+
+*/
+/* TODO - DELETE
+
+These calls work at the project directory, using samples in the data/ directory:
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-missing.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-missing.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-unassigned.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-unassigned.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv --empty
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv --empty
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-discontiguous.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-discontiguous.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+./main.js testlog -n 13 -p ../data/SAMPLE-BG-map-hole.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+./main.js scorecard -n 13 -p ../data/SAMPLE-BG-map-hole.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+node main.js scorecard -v -n 13 -p ../data/SAMPLE-BG-map.csv -c ../data/SAMPLE-BG-census.csv -s ../data/SAMPLE-BG-shapes.geojson -g ../data/SAMPLE-BG-graph.json -e ../data/SAMPLE-BG-election.csv -f ../data/SAMPLE-FIPS-county-name-map.csv
+
+
+These calls test NC block-level data stored in my ~/data/redistricting-data/2010/compact/sample directory:
+
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-shapes.geojson -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+node --inspect --inspect-brk main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/tl_2018_37_tabblock10.json -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+
+node main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-shapes.geojson -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+node main.js scorecard -v -n 13 -p ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-map.csv -c ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-census.csv -s ~/data/redistricting-data/2010/compact/sample/tl_2018_37_tabblock10.json -g ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-graph.json -e ~/data/redistricting-data/2010/compact/sample/SAMPLE-BLOCK-election.csv -f ~/data/redistricting-data/2010/compact/sample/SAMPLE-FIPS-county-name-map.csv
+
+*/
+//# sourceMappingURL=report.js.map