@dra2020/district-analytics 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alec Ramsay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# District Analytics
+
+Analytics for scoring congressional and legislative district maps.
+
+## Sample Code
+
+```javascript
+import * as DA from 'district-analytics';
+
+let sr = {} as DA.SessionRequest;
+sr['title'] = "NC 2016 Contingent Corrected Map";
+sr['stateXX'] = "NC";
+sr['nDistricts'] = 13;
+sr['data'] = data as T.GeoFeatureCollection;
+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['config'] = config as T.Dict;
+
+let text: any;
+let score: DA.GradedTest | DA.PassFailTest;
+let s = new DA.AnalyticsSession(sr);
+
+s.analyzePlan();
+text = s.prepareScorecard();
+text = s.prepareTestLog();
+
+s.getTest(DA.Tests.Contiguous)
+```
+
+## License
+
+Distributed under the [The MIT License (MIT)](https://github.com/alecramsay/district-analytics/blob/master/LICENSE) Copyright © 2019 Alec Ramsay