@dra2020/district-analytics 1.0.6 → 1.0.9

package/dist/settings.d.ts

@@ -1,5 +0,0 @@
-export declare const PRECISION: number;
-export declare const NORMALIZED_RANGE: number;
-export declare const NOT_ASSIGNED: number;
-export declare const NUMBER_OF_ITEMS_TO_REPORT: number;
-export declare const OUT_OF_STATE: string;

package/dist/types.d.ts

@@ -1,110 +0,0 @@
-import * as geojson from 'geojson';
-export declare const enum Suite {
-    Legal = 0,
-    Fair = 1,
-    Best = 2
-}
-export declare type SessionRequest = {
-    title: string;
-    stateXX: string;
-    nDistricts: number;
-    legislativeDistricts: boolean;
-    plan: PlanByGeoID;
-    data: GeoFeatureCollection;
-    districtShapes: GeoFeatureCollection;
-    districtProperties: DistrictProperties;
-    graph: ContiguityGraph;
-    countyNameLookup: FIPSCodeToCountyNameMap;
-    counties: GeoFeatureCollection;
-    config: {};
-};
-export declare type PlanByGeoID = {
-    [geoID: string]: number;
-};
-export declare type PlanByDistrictID = {
-    [districtID: number]: Set<string>;
-};
-export declare type FeaturesByGeoID = {
-    [geoID: string]: number;
-};
-export declare type FIPSCodeToCountyNameMap = {
-    [FIPSCode: string]: string;
-};
-export declare type FIPSToOrdinalMap = {
-    [FIPSCode: string]: number;
-};
-export declare type GeoFeature = geojson.Feature;
-export declare type GeoFeatureArray = GeoFeature[];
-export declare type GeoFeatureCollection = geojson.FeatureCollection;
-export interface GeoFeatureMap {
-    [geoID: string]: GeoFeature;
-}
-export declare type ContiguityGraph = {
-    [geoID: string]: Neighbors;
-};
-export declare type Neighbors = {
-    [geoID: string]: number;
-};
-export declare type VoteTriple = [number, number, number];
-export declare const enum VoteType {
-    Democratic = 0,
-    Republican = 1,
-    Total = 2
-}
-export declare type TestScale = {
-    testScale: Array<number>;
-    testInvertp: boolean;
-};
-export declare type TestScales = {
-    [test: number]: TestScale;
-};
-export declare type TestEntry = {
-    score?: number | boolean;
-    details: Dict;
-    normalizedScore?: number;
-};
-export declare type DistrictWIP = {
-    [districtID: number]: any;
-};
-export declare const enum Test {
-    Complete = 0,
-    Contiguous = 1,
-    FreeOfHoles = 2,
-    EqualPopulation = 3,
-    PopulationDeviation = 4,
-    Reock = 5,
-    PolsbyPopper = 6,
-    CountySplits = 7,
-    Complexity = 8,
-    SeatsBias = 9,
-    VotesBias = 10,
-    Responsiveness = 11,
-    ResponsiveDistricts = 12,
-    EfficiencyGap = 13,
-    MajorityMinorityDistricts = 14
-}
-export declare type TestEntries = {
-    [test: number]: TestEntry;
-};
-export declare type DistrictProperties = {
-    [districtID: number]: any;
-};
-export declare type DistrictShapeProperties = [number, number, number];
-export declare const enum DistrictShapeProperty {
-    Area = 0,
-    Diameter = 1,
-    Perimeter = 2
-}
-export declare type GeoIDParts = {
-    state?: string;
-    county?: string;
-    tract?: string;
-    bg?: string;
-    block?: string;
-};
-export declare type GeoIDTotal = {
-    [geoID: string]: number;
-};
-export declare type Dict = {
-    [key: string]: any;
-};

package/dist/utils.d.ts

@@ -1,28 +0,0 @@
-import * as T from './types';
-export declare function isInState(geoID: string): boolean;
-export declare function isOutOfState(geoID: string): boolean;
-export declare function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined;
-export declare function invertPlan(plan: T.PlanByGeoID): T.PlanByDistrictID;
-export declare function parseGeoID(geoID: string): T.GeoIDParts;
-export declare function getFIPSFromCountyGeoID(geoID: string): string;
-export declare function normalize(rawScore: number, scale: Array<number>, invertp?: boolean): number;
-export declare function trim(fullFraction: number): number;
-export declare function sumArray(arr: number[]): number;
-export declare function avgArray(arr: number[]): number;
-export declare function minArray(arr: number[]): number;
-export declare function maxArray(arr: number[]): number;
-export declare function initArray(n: number, value: any): any[];
-export declare function andArray(arr: boolean[]): boolean;
-export declare function keyExists(k: string, o: object): boolean;
-export declare function isObjectEmpty(o: object): boolean;
-export declare function isSetEmpty(s: any): boolean;
-export declare function isArrayEmpty(a: any[]): boolean;
-export declare function getObjectKeys(o: object): string[];
-export declare function getNumericObjectKeys(o: object): number[];
-export declare function getSelectObjectKeys(o: T.Dict, v: any[]): string[];
-export declare function arrayContains(a: any[], item: any): boolean;
-export declare function objectContains(o: object, key: any): boolean;
-export declare function countEnumValues(enumName: any): number;
-export declare function shallowCopy(src: any): any;
-export declare function deepCopy(src: any): any;
-export { depthof } from '@dra2020/util';

package/dist/valid.d.ts

@@ -1,8 +0,0 @@
-import * as T from './types';
-import * as D from './_data';
-import { AnalyticsSession } from './_api';
-export declare function doIsComplete(s: AnalyticsSession): T.TestEntry;
-export declare function doIsContiguous(s: AnalyticsSession): T.TestEntry;
-export declare function isConnected(districtGeos: Set<string>, graph: D.Graph): boolean;
-export declare function doIsFreeOfHoles(s: AnalyticsSession): T.TestEntry;
-export declare function isEmbedded(districtID: number, geoIDs: Set<string>, plan: D.Plan, graph: D.Graph): boolean;

package/jestconfig.json

@@ -1,14 +0,0 @@
-{
-  "transform": {
-    "^.+\\.(t|j)sx?$": "ts-jest"
-  },
-  "testRegex": "(/_tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-  "moduleFileExtensions": [
-    "ts",
-    "tsx",
-    "js",
-    "jsx",
-    "json",
-    "node"
-  ]
-}

package/main.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-// Invoke the CLI
-var run = require('./dist/cli.js');

package/src/_api.ts

@@ -1,120 +0,0 @@
-//
-// THE NODE PACKAGE API
-//
-
-import { doPreprocessData } from './preprocess'
-import { doAnalyzePlan, doAnalyzeDistricts } from './analyze'
-import {
-  doConfigureScales, doAnalyzePostProcessing, doPrepareScorecard,
-  doPrepareTestLog, Scorecard
-} from './report'
-
-import * as D from './_data';
-import * as T from './types'
-import * as U from './utils';
-import * as S from './settings';
-
-export class AnalyticsSession {
-  title: string;
-  legislativeDistricts: boolean;
-  config: T.Dict = {};
-
-  bOneTimeProcessingDone = false;
-  bPlanAnalyzed = false;
-  bPostProcessingDone = false;
-  testScales = {} as T.TestScales;
-  tests = {} as T.TestEntries;
-  scorecard = {} as Scorecard;
-
-  state: D.State;
-  counties: D.Counties;
-  graph: D.Graph;
-  features: D.Features;
-  plan: D.Plan;
-  districts: D.Districts;
-
-  constructor(SessionRequest: T.SessionRequest) {
-    this.title = SessionRequest['title'];
-    this.legislativeDistricts = SessionRequest['legislativeDistricts'];
-    this.config = this.processConfig(SessionRequest['config'])
-
-    this.state = new D.State(this, SessionRequest['stateXX'], SessionRequest['nDistricts']);
-    this.counties = new D.Counties(this, SessionRequest['counties']);
-    this.graph = new D.Graph(this, SessionRequest['graph']);
-    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']);
-
-    // 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.
-    doConfigureScales(this);
-  }
-  processConfig(config: T.Dict): T.Dict {
-    // NOTE - Session settings are required:
-    // - Analytics suites can be defaulted to all with [], but
-    // - Dataset keys must be explicitly specified with 'dataset'
-
-    let defaultSuites = [T.Suite.Legal, T.Suite.Fair, T.Suite.Best];
-
-    // If the config passed in has no suites = [], use the default suites
-    if (U.isArrayEmpty(config['suites'])) {
-      config['suites'] = defaultSuites;
-    }
-
-    // Default the Census & redistricting cycle to 2010
-    if (!(U.keyExists('cycle', config))) config['cycle'] = 2010;
-
-    return config;
-  }
-
-  // Using the the data in the analytics session, calculate all the
-  // analytics & validations, saving/updating the individual test results.
-  analyzePlan(bLog: boolean = false): boolean {
-    try {
-      doPreprocessData(this);
-      doAnalyzeDistricts(this, bLog);
-      doAnalyzePlan(this, bLog);
-      doAnalyzePostProcessing(this);
-    }
-    catch {
-      return false;
-    }
-
-    return true;
-  }
-
-  // Get an individual test, so you can drive UI with the results.
-  getTest(testID: T.Test): T.TestEntry {
-    // Get the existing test entries
-    // T.Test is a numeric enum, so convert the string keys to numbers
-    let testValues = U.getNumericObjectKeys(this.tests);
-
-    // If there's no entry for this test, create & initialize one
-    if (!(testValues.includes(testID))) {
-      this.tests[testID] = {} as T.TestEntry;
-      this.tests[testID]['score'] = undefined;
-      this.tests[testID]['details'] = {};
-    }
-
-    // Return a pointer to the the test entry for this test
-    return this.tests[testID];
-  }
-
-  // Prepare a scorecard for rendering
-  // NOTE - This assumes that analyzePlan() has been run!
-  prepareScorecard(): any {
-    return doPrepareScorecard(this);
-  }
-
-  // Prepare test results for rendering
-  // NOTE - This assumes that analyzePlan() has been run!
-  prepareTestLog(): any {
-    return doPrepareTestLog(this);
-  }
-
-  populationDeviationThreshold(): number {
-    return 1 - this.testScales[T.Test.PopulationDeviation]['testScale'][0];
-  }
-}
-