@turf/moran-index 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -9,77 +9,96 @@ The method reveal whether similar values tend to occur near each other,
 or whether high or low values are interspersed.
 
 Moran's I > 0 means a clusterd pattern.
-Moran's I < 0 means a dispersed pattern.
+Moran's I < 0 means a dispersed pattern.
 Moran's I = 0 means a random pattern.
 
 In order to test the significance of the result. The z score is calculated.
 A positive enough z-score (ex. >1.96) indicates clustering,
-while a negative enough z-score (ex. &lt;-1.96) indicates a dispersed pattern.
+while a negative enough z-score (ex. <-1.96) indicates a dispersed pattern.
 
 the z-score can be calculated based on a normal or random assumption.
 
-**Bibliography\***
+**Bibliography**\*
 
-1.  [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)
+1.  [Moran's I][1]
 
-2.  [pysal](http://pysal.readthedocs.io/en/latest/index.html)
+2.  [pysal][2]
 
 3.  Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.
 
-**Parameters**
+### Parameters
 
--   `fc` **[FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3)&lt;any>** 
--   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-    -   `options.inputField` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the property name, must contain numeric values
-    -   `options.threshold` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the distance threshold (optional, default `100000`)
-    -   `options.p` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the Minkowski p-norm distance parameter (optional, default `2`)
-    -   `options.binary` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** whether transfrom the distance to binary (optional, default `false`)
-    -   `options.alpha` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the distance decay parameter (optional, default `-1`)
-    -   `options.standardization` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** wheter row standardization the distance (optional, default `true`)
+*   `fc` **[FeatureCollection][3]\<any>** 
+*   `options` **[Object][4]** 
 
-**Examples**
+    *   `options.inputField` **[string][5]** the property name, must contain numeric values
+    *   `options.threshold` **[number][6]** the distance threshold (optional, default `100000`)
+    *   `options.p` **[number][6]** the Minkowski p-norm distance parameter (optional, default `2`)
+    *   `options.binary` **[boolean][7]** whether transfrom the distance to binary (optional, default `false`)
+    *   `options.alpha` **[number][6]** the distance decay parameter (optional, default `-1`)
+    *   `options.standardization` **[boolean][7]** wheter row standardization the distance (optional, default `true`)
+
+### Examples
 
 ```javascript
 const bbox = [-65, 40, -63, 42];
 const dataset = turf.randomPoint(100, { bbox: bbox });
 
-const result = moranIndex(pts, {
+const result = turf.moranIndex(dataset, {
   inputField: 'CRIME',
 });
 ```
 
-Returns **[MoranIndex](#moranindex)** 
+Returns **[MoranIndex][8]** 
 
 ## mean
 
 get mean of a list
 
-**Parameters**
+### Parameters
 
--   `y` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>** 
+*   `y` **[Array][9]<[number][6]>** 
 
-Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+Returns **[number][6]** 
 
 ## variance
 
 get variance of a list
 
-**Parameters**
+### Parameters
 
--   `y` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>** 
+*   `y` **[Array][9]<[number][6]>** 
 
-Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+Returns **[number][6]** 
 
 ## MoranIndex
 
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+Type: [Object][4]
+
+### Properties
+
+*   `moranIndex` **[number][6]** the moran's Index of the observed feature set
+*   `expectedMoranIndex` **[number][6]** the moran's Index of the random distribution
+*   `stdNorm` **[number][6]** the standard devitaion of the random distribution
+*   `zNorm` **[number][6]** the z-score of the observe samples with regard to the random distribution
+
+[1]: https://en.wikipedia.org/wiki/Moran%27s_I
+
+[2]: http://pysal.readthedocs.io/en/latest/index.html
+
+[3]: https://tools.ietf.org/html/rfc7946#section-3.3
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-**Properties**
+[8]: #moranindex
 
--   `moranIndex` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the moran's Index of the observed feature set
--   `expectedMoranIndex` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the moran's Index of the random distribution
--   `stdNorm` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the standard devitaion of the random distribution
--   `zNorm` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the z-score of the observe samples with regard to the random distribution
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

package/dist/es/index.js

@@ -43,36 +43,36 @@ import { featureEach } from "@turf/meta";
  * });
  */
 export default function (fc, options) {
-    var inputField = options.inputField;
-    var threshold = options.threshold || 100000;
-    var p = options.p || 2;
-    var binary = options.binary || false;
-    var alpha = options.alpha || -1;
-    var standardization = options.standardization || true;
-    var weight = spatialWeight(fc, {
-        alpha: alpha,
-        binary: binary,
-        p: p,
-        standardization: standardization,
-        threshold: threshold,
+    const inputField = options.inputField;
+    const threshold = options.threshold || 100000;
+    const p = options.p || 2;
+    const binary = options.binary || false;
+    const alpha = options.alpha || -1;
+    const standardization = options.standardization || true;
+    const weight = spatialWeight(fc, {
+        alpha,
+        binary,
+        p,
+        standardization,
+        threshold,
     });
-    var y = [];
-    featureEach(fc, function (feature) {
-        var feaProperties = feature.properties || {};
+    const y = [];
+    featureEach(fc, (feature) => {
+        const feaProperties = feature.properties || {};
         // validate inputField exists
         y.push(feaProperties[inputField]);
     });
-    var yMean = mean(y);
-    var yVar = variance(y);
-    var weightSum = 0;
-    var s0 = 0;
-    var s1 = 0;
-    var s2 = 0;
-    var n = weight.length;
+    const yMean = mean(y);
+    const yVar = variance(y);
+    let weightSum = 0;
+    let s0 = 0;
+    let s1 = 0;
+    let s2 = 0;
+    const n = weight.length;
     // validate y.length is the same as weight.length
-    for (var i = 0; i < n; i++) {
-        var subS2 = 0;
-        for (var j = 0; j < n; j++) {
+    for (let i = 0; i < n; i++) {
+        let subS2 = 0;
+        for (let j = 0; j < n; j++) {
             weightSum += weight[i][j] * (y[i] - yMean) * (y[j] - yMean);
             s0 += weight[i][j];
             s1 += Math.pow(weight[i][j] + weight[j][i], 2);
@@ -81,18 +81,18 @@ export default function (fc, options) {
         s2 += Math.pow(subS2, 2);
     }
     s1 = 0.5 * s1;
-    var moranIndex = weightSum / s0 / yVar;
-    var expectedMoranIndex = -1 / (n - 1);
-    var vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);
-    var vDen = (n - 1) * (n + 1) * (s0 * s0);
-    var vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;
-    var stdNorm = Math.sqrt(vNorm);
-    var zNorm = (moranIndex - expectedMoranIndex) / stdNorm;
+    const moranIndex = weightSum / s0 / yVar;
+    const expectedMoranIndex = -1 / (n - 1);
+    const vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);
+    const vDen = (n - 1) * (n + 1) * (s0 * s0);
+    const vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;
+    const stdNorm = Math.sqrt(vNorm);
+    const zNorm = (moranIndex - expectedMoranIndex) / stdNorm;
     return {
-        expectedMoranIndex: expectedMoranIndex,
-        moranIndex: moranIndex,
-        stdNorm: stdNorm,
-        zNorm: zNorm,
+        expectedMoranIndex,
+        moranIndex,
+        stdNorm,
+        zNorm,
     };
 }
 /**
@@ -102,9 +102,8 @@ export default function (fc, options) {
  *
  */
 function mean(y) {
-    var sum = 0;
-    for (var _i = 0, y_1 = y; _i < y_1.length; _i++) {
-        var item = y_1[_i];
+    let sum = 0;
+    for (const item of y) {
         sum += item;
     }
     return sum / y.length;
@@ -116,10 +115,9 @@ function mean(y) {
  *
  */
 function variance(y) {
-    var yMean = mean(y);
-    var sum = 0;
-    for (var _i = 0, y_2 = y; _i < y_2.length; _i++) {
-        var item = y_2[_i];
+    const yMean = mean(y);
+    let sum = 0;
+    for (const item of y) {
         sum += Math.pow(item - yMean, 2);
     }
     return sum / y.length;

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { FeatureCollection } from "@turf/helpers";
+import { FeatureCollection } from "geojson";
 /**
  * Moran's I measures patterns of attribute values associated with features.
  * The method reveal whether similar values tend to occur near each other,

package/dist/js/index.js

@@ -1,10 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var distance_weight_1 = __importDefault(require("@turf/distance-weight"));
-var meta_1 = require("@turf/meta");
+const tslib_1 = require("tslib");
+const distance_weight_1 = tslib_1.__importDefault(require("@turf/distance-weight"));
+const meta_1 = require("@turf/meta");
 /**
  * Moran's I measures patterns of attribute values associated with features.
  * The method reveal whether similar values tend to occur near each other,
@@ -48,36 +46,36 @@ var meta_1 = require("@turf/meta");
  * });
  */
 function default_1(fc, options) {
-    var inputField = options.inputField;
-    var threshold = options.threshold || 100000;
-    var p = options.p || 2;
-    var binary = options.binary || false;
-    var alpha = options.alpha || -1;
-    var standardization = options.standardization || true;
-    var weight = distance_weight_1.default(fc, {
-        alpha: alpha,
-        binary: binary,
-        p: p,
-        standardization: standardization,
-        threshold: threshold,
+    const inputField = options.inputField;
+    const threshold = options.threshold || 100000;
+    const p = options.p || 2;
+    const binary = options.binary || false;
+    const alpha = options.alpha || -1;
+    const standardization = options.standardization || true;
+    const weight = distance_weight_1.default(fc, {
+        alpha,
+        binary,
+        p,
+        standardization,
+        threshold,
     });
-    var y = [];
-    meta_1.featureEach(fc, function (feature) {
-        var feaProperties = feature.properties || {};
+    const y = [];
+    meta_1.featureEach(fc, (feature) => {
+        const feaProperties = feature.properties || {};
         // validate inputField exists
         y.push(feaProperties[inputField]);
     });
-    var yMean = mean(y);
-    var yVar = variance(y);
-    var weightSum = 0;
-    var s0 = 0;
-    var s1 = 0;
-    var s2 = 0;
-    var n = weight.length;
+    const yMean = mean(y);
+    const yVar = variance(y);
+    let weightSum = 0;
+    let s0 = 0;
+    let s1 = 0;
+    let s2 = 0;
+    const n = weight.length;
     // validate y.length is the same as weight.length
-    for (var i = 0; i < n; i++) {
-        var subS2 = 0;
-        for (var j = 0; j < n; j++) {
+    for (let i = 0; i < n; i++) {
+        let subS2 = 0;
+        for (let j = 0; j < n; j++) {
             weightSum += weight[i][j] * (y[i] - yMean) * (y[j] - yMean);
             s0 += weight[i][j];
             s1 += Math.pow(weight[i][j] + weight[j][i], 2);
@@ -86,18 +84,18 @@ function default_1(fc, options) {
         s2 += Math.pow(subS2, 2);
     }
     s1 = 0.5 * s1;
-    var moranIndex = weightSum / s0 / yVar;
-    var expectedMoranIndex = -1 / (n - 1);
-    var vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);
-    var vDen = (n - 1) * (n + 1) * (s0 * s0);
-    var vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;
-    var stdNorm = Math.sqrt(vNorm);
-    var zNorm = (moranIndex - expectedMoranIndex) / stdNorm;
+    const moranIndex = weightSum / s0 / yVar;
+    const expectedMoranIndex = -1 / (n - 1);
+    const vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);
+    const vDen = (n - 1) * (n + 1) * (s0 * s0);
+    const vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;
+    const stdNorm = Math.sqrt(vNorm);
+    const zNorm = (moranIndex - expectedMoranIndex) / stdNorm;
     return {
-        expectedMoranIndex: expectedMoranIndex,
-        moranIndex: moranIndex,
-        stdNorm: stdNorm,
-        zNorm: zNorm,
+        expectedMoranIndex,
+        moranIndex,
+        stdNorm,
+        zNorm,
     };
 }
 exports.default = default_1;
@@ -108,9 +106,8 @@ exports.default = default_1;
  *
  */
 function mean(y) {
-    var sum = 0;
-    for (var _i = 0, y_1 = y; _i < y_1.length; _i++) {
-        var item = y_1[_i];
+    let sum = 0;
+    for (const item of y) {
         sum += item;
     }
     return sum / y.length;
@@ -122,10 +119,9 @@ function mean(y) {
  *
  */
 function variance(y) {
-    var yMean = mean(y);
-    var sum = 0;
-    for (var _i = 0, y_2 = y; _i < y_2.length; _i++) {
-        var item = y_2[_i];
+    const yMean = mean(y);
+    let sum = 0;
+    for (const item of y) {
         sum += Math.pow(item - yMean, 2);
     }
     return sum / y.length;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/moran-index",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf moran-index module",
   "author": "Turf Authors",
   "contributors": [
@@ -28,6 +28,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -38,13 +39,13 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js"
+    "test:tape": "tsx test.js"
   },
   "devDependencies": {
     "@types/tape": "*",
@@ -52,15 +53,16 @@
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/distance-weight": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0"
+    "@turf/distance-weight": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }