@dra2020/district-analytics 16.1.14 → 17.0.2

package/README.md

@@ -1,6 +1,9 @@
 # District Analytics
 
-Type definitions and code used by dra-client and fn-all (lambdas), and which invokes dra-analytics 
+A layer between dra-client and fn-all (scoring lambda) that knows enough about DRA and analytics proper (in dra-analytics)
+to take data in, compose the various analytics calls, and return the scorecards, etc. that they want. This allows the callers
+to remain high-level and agnostic of the analytics specifics, on the one hand, and the analytics proper to no nothing about
+DRA, on the other. 
 
 ## Build Status
 
@@ -12,9 +15,9 @@ Type definitions and code used by dra-client and fn-all (lambdas), and which inv
 import * as DA from 'district-analytics';
 
 let sr = {} as DA.SessionRequest;
-sr['title'] = "NC 2016 Contingent Corrected Map";
+sr['title'] = "NC 2020 Congress";
 sr['stateXX'] = "NC";
-sr['nDistricts'] = 13;
+sr['nDistricts'] = 14;
 sr['planType'] = PlanType.congress;  // One or ...
 sr['legislativeDistricts'] = false;  // ... the other
 sr['data'] = data as T.GeoFeatureCollection;
@@ -22,6 +25,8 @@ sr['counties'] = counties as T.GeoFeatureCollection;
 sr['graph'] = graph as T.ContiguityGraph;
 sr['plan'] = planByGeoID as DA.PlanByGeoID;
 sr['districtShapes'] = districtShapes as T.GeoFeatureCollection;
+sr['aggregates'] = aggregates as PF.PackedFields[];
+sr['datasetsMeta'] = datasetsMeta as DT.DatasetsMeta;
 sr['config'] = config as T.Dict;
 
 let s = new DA.AnalyticsSession(sr);
@@ -29,15 +34,8 @@ let s = new DA.AnalyticsSession(sr);
 let bLog = false;
 s.analyzePlan(bLog);
 
-const statistics: DA.DistrictStatistics = s.getDistrictStatistics();
 const requirements: DA.RequirementsChecklist = s.getRequirementsChecklist();
 const scorecard: DA.Scorecard = s.getPlanScorecard();
 const ratings: DA.Ratings = s.getRatings();
-
-const discontiguous = DA.GeoFeatureCollection = s.getDiscontiguousDistrictFeatures();
-
 ```
 
-## License
-
-Distributed under the [The MIT License (MIT)](https://github.com/alecramsay/district-analytics/blob/master/LICENSE) Copyright © 2019 Alec Ramsay

package/dist/_api.d.ts

@@ -1,3 +1,4 @@
+import { DT, PF } from '@dra2020/dra-types';
 import { Types } from '@dra2020/dra-analytics';
 import { RequirementsChecklist } from './results';
 import { DistrictStatistics } from './results';
@@ -20,6 +21,8 @@ export declare class AnalyticsSession {
     features: D.Features;
     plan: D.Plan;
     districts: D.Districts;
+    aggregates: PF.PackedFields[];
+    datasetsMeta: DT.DatasetsMeta;
     repsByDistrict?: number[];
     constructor(SessionRequest: T.SessionRequest);
     processConfig(config: T.Dict): T.Dict;

package/dist/data.d.ts

@@ -0,0 +1,68 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare class Districts {
+    _session: AnalyticsSession;
+    _shapes: T.GeoFeatureCollection;
+    _geoProperties: T.DistrictProperties;
+    constructor(s: AnalyticsSession, ds: T.GeoFeatureCollection);
+    getDistrictShapes(): T.GeoFeatureCollection;
+    getDistrictShapeByID(id: number): T.GeoFeature | undefined;
+    getCountyIndex(geoID: string): number;
+}
+export declare class Features {
+    _session: AnalyticsSession;
+    _data: T.GeoFeatureCollection;
+    _keys: T.DatasetKeys;
+    _featureIDs: T.FeaturesByGeoID;
+    constructor(s: AnalyticsSession, data: T.GeoFeatureCollection, keys: T.DatasetKeys);
+    nFeatures(): number;
+    featureByIndex(i: number): T.GeoFeature;
+    resetDataset(d: T.Dataset, k: string): void;
+    mapGeoIDsToFeatureIDs(): void;
+    featureID(i: string): number;
+}
+export declare function geoIDForFeature(f: any): string;
+export declare function fieldForFeature(f: any, dk: string, ff: T.FeatureField): any;
+export declare class Counties {
+    _session: AnalyticsSession;
+    _data: T.GeoFeatureCollection;
+    _countyNameLookup: T.FIPSCodeToCountyNameMap;
+    nCounties: number;
+    index: T.FIPSToOrdinalMap;
+    fips: T.OrdinalToFIPSlMap;
+    totalPopulation: number[];
+    constructor(s: AnalyticsSession, data: T.GeoFeatureCollection);
+    countyByIndex(i: number): T.GeoFeature;
+    propertyForCounty(f: any, pk: string): any;
+    mapFIPSToName(fips: string, name: string): void;
+    nameFromFIPS(fips: string): string;
+    indexFromFIPS(fips: string): number;
+}
+export declare class State {
+    _session: AnalyticsSession;
+    xx: string;
+    nDistricts: number;
+    nReps: number;
+    totalPop: number;
+    targetSize: number;
+    tooBigFIPS: string[];
+    tooBigName: string[];
+    singleCountyDistrictMax: number;
+    expectedSplits: number;
+    expectedAffected: number;
+    constructor(s: AnalyticsSession, xx: string, n: number);
+}
+export declare class Plan {
+    _session: AnalyticsSession;
+    _planByGeoID: T.PlanByGeoID;
+    _planByDistrictID: T.PlanByDistrictID;
+    districtIDs: number[];
+    constructor(s: AnalyticsSession, p: T.PlanByGeoID);
+    invertPlan(bLog?: boolean): void;
+    initializeDistrict(i: number): void;
+    byGeoID(): T.PlanByGeoID;
+    byDistrictID(): T.PlanByDistrictID;
+    districtForGeoID(i: string): number;
+    geoIDsForDistrictID(i: number): Set<string>;
+}
+export declare function invertPlan(plan: T.PlanByGeoID, s?: AnalyticsSession, bLog?: boolean): T.PlanByDistrictID;

package/dist/district-analytics.js

@@ -105,6 +105,8 @@ 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']);
+        this.aggregates = SessionRequest['aggregates'];
+        this.datasetsMeta = SessionRequest['datasetsMeta'];
     }
     processConfig(config) {
         // Default the Census & redistricting cycle to 2010