@turf/moran-index 7.0.0-alpha.0 → 7.0.0-alpha.110

package/README.md

@@ -100,26 +100,21 @@ Type: [Object][4]
 
 [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
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/moran-index
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,82 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _distanceweight = require('@turf/distance-weight');
+var _meta = require('@turf/meta');
+function moranIndex(fc, options) {
+  var _a, _b;
+  const inputField = options.inputField;
+  const threshold = options.threshold || 1e5;
+  const p = options.p || 2;
+  const binary = (_a = options.binary) != null ? _a : false;
+  const alpha = options.alpha || -1;
+  const standardization = (_b = options.standardization) != null ? _b : true;
+  const weight = _distanceweight.distanceWeight.call(void 0, fc, {
+    alpha,
+    binary,
+    p,
+    standardization,
+    threshold
+  });
+  const y = [];
+  _meta.featureEach.call(void 0, fc, (feature) => {
+    const feaProperties = feature.properties || {};
+    y.push(feaProperties[inputField]);
+  });
+  const yMean = mean(y);
+  const yVar = variance(y);
+  let weightSum = 0;
+  let s0 = 0;
+  let s1 = 0;
+  let s2 = 0;
+  const n = weight.length;
+  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);
+      subS2 += weight[i][j] + weight[j][i];
+    }
+    s2 += Math.pow(subS2, 2);
+  }
+  s1 = 0.5 * s1;
+  const moranIndex2 = 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 = (moranIndex2 - expectedMoranIndex) / stdNorm;
+  return {
+    expectedMoranIndex,
+    moranIndex: moranIndex2,
+    stdNorm,
+    zNorm
+  };
+}
+__name(moranIndex, "moranIndex");
+function mean(y) {
+  let sum = 0;
+  for (const item of y) {
+    sum += item;
+  }
+  return sum / y.length;
+}
+__name(mean, "mean");
+function variance(y) {
+  const yMean = mean(y);
+  let sum = 0;
+  for (const item of y) {
+    sum += Math.pow(item - yMean, 2);
+  }
+  return sum / y.length;
+}
+__name(variance, "variance");
+var turf_moran_index_default = moranIndex;
+
+
+
+exports.default = turf_moran_index_default; exports.moranIndex = moranIndex;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":["moranIndex"],"mappings":";;;;AACA,SAAS,kBAAkB,qBAAqB;AAChD,SAAS,mBAAmB;AA6C5B,SAAS,WACP,IACA,SAaA;AA9DF;AA+DE,QAAM,aAAa,QAAQ;AAC3B,QAAM,YAAY,QAAQ,aAAa;AACvC,QAAM,IAAI,QAAQ,KAAK;AACvB,QAAM,UAAS,aAAQ,WAAR,YAAkB;AACjC,QAAM,QAAQ,QAAQ,SAAS;AAC/B,QAAM,mBAAkB,aAAQ,oBAAR,YAA2B;AAEnD,QAAM,SAAS,cAAc,IAAI;AAAA,IAC/B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,IAAc,CAAC;AACrB,cAAY,IAAI,CAAC,YAAY;AAC3B,UAAM,gBAAgB,QAAQ,cAAc,CAAC;AAE7C,MAAE,KAAK,cAAc,UAAU,CAAC;AAAA,EAClC,CAAC;AAED,QAAM,QAAQ,KAAK,CAAC;AACpB,QAAM,OAAO,SAAS,CAAC;AACvB,MAAI,YAAY;AAChB,MAAI,KAAK;AACT,MAAI,KAAK;AACT,MAAI,KAAK;AACT,QAAM,IAAI,OAAO;AAEjB,WAAS,IAAI,GAAG,IAAI,GAAG,KAAK;AAC1B,QAAI,QAAQ;AACZ,aAAS,IAAI,GAAG,IAAI,GAAG,KAAK;AAC1B,mBAAa,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,IAAI;AACrD,YAAM,OAAO,CAAC,EAAE,CAAC;AACjB,YAAM,KAAK,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC;AAC7C,eAAS,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC;AAAA,IACrC;AACA,UAAM,KAAK,IAAI,OAAO,CAAC;AAAA,EACzB;AACA,OAAK,MAAM;AAEX,QAAMA,cAAa,YAAY,KAAK;AACpC,QAAM,qBAAqB,MAAM,IAAI;AACrC,QAAM,OAAO,IAAI,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK;AAC7C,QAAM,QAAQ,IAAI,MAAM,IAAI,MAAM,KAAK;AACvC,QAAM,QAAQ,OAAO,OAAO,qBAAqB;AACjD,QAAM,UAAU,KAAK,KAAK,KAAK;AAC/B,QAAM,SAASA,cAAa,sBAAsB;AAElD,SAAO;AAAA,IACL;AAAA,IACA,YAAAA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAxES;AAgFT,SAAS,KAAK,GAAqB;AACjC,MAAI,MAAM;AACV,aAAW,QAAQ,GAAG;AACpB,WAAO;AAAA,EACT;AACA,SAAO,MAAM,EAAE;AACjB;AANS;AAaT,SAAS,SAAS,GAAqB;AACrC,QAAM,QAAQ,KAAK,CAAC;AACpB,MAAI,MAAM;AACV,aAAW,QAAQ,GAAG;AACpB,WAAO,KAAK,IAAI,OAAO,OAAO,CAAC;AAAA,EACjC;AACA,SAAO,MAAM,EAAE;AACjB;AAPS;AAkBT,IAAO,2BAAQ","sourcesContent":["import { FeatureCollection } from \"geojson\";\nimport { distanceWeight as spatialWeight } from \"@turf/distance-weight\";\nimport { featureEach } from \"@turf/meta\";\n\n/**\n * Moran's I measures patterns of attribute values associated with features.\n * The method reveal whether similar values tend to occur near each other,\n * or whether high or low values are interspersed.\n *\n * Moran's I > 0 means a clusterd pattern.\n * Moran's I < 0 means a dispersed pattern.\n * Moran's I = 0 means a random pattern.\n *\n * In order to test the significance of the result. The z score is calculated.\n * A positive enough z-score (ex. >1.96) indicates clustering,\n * while a negative enough z-score (ex. <-1.96) indicates a dispersed pattern.\n *\n * the z-score can be calculated based on a normal or random assumption.\n *\n * **Bibliography***\n *\n * 1. [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)\n *\n * 2. [pysal](http://pysal.readthedocs.io/en/latest/index.html)\n *\n * 3. Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.\n *\n * @name moranIndex\n * @param {FeatureCollection<any>} fc\n * @param {Object} options\n * @param {string} options.inputField the property name, must contain numeric values\n * @param {number} [options.threshold=100000] the distance threshold\n * @param {number} [options.p=2] the Minkowski p-norm distance parameter\n * @param {boolean} [options.binary=false] whether transfrom the distance to binary\n * @param {number} [options.alpha=-1] the distance decay parameter\n * @param {boolean} [options.standardization=true] wheter row standardization the distance\n * @returns {MoranIndex}\n * @example\n *\n * const bbox = [-65, 40, -63, 42];\n * const dataset = turf.randomPoint(100, { bbox: bbox });\n *\n * const result = turf.moranIndex(dataset, {\n *   inputField: 'CRIME',\n * });\n */\n\nfunction moranIndex(\n  fc: FeatureCollection<any>,\n  options: {\n    inputField: string;\n    threshold?: number;\n    p?: number;\n    binary?: boolean;\n    alpha?: number;\n    standardization?: boolean;\n  }\n): {\n  moranIndex: number;\n  expectedMoranIndex: number;\n  stdNorm: number;\n  zNorm: number;\n} {\n  const inputField = options.inputField;\n  const threshold = options.threshold || 100000;\n  const p = options.p || 2;\n  const binary = options.binary ?? false;\n  const alpha = options.alpha || -1;\n  const standardization = options.standardization ?? true;\n\n  const weight = spatialWeight(fc, {\n    alpha,\n    binary,\n    p,\n    standardization,\n    threshold,\n  });\n\n  const y: number[] = [];\n  featureEach(fc, (feature) => {\n    const feaProperties = feature.properties || {};\n    // validate inputField exists\n    y.push(feaProperties[inputField]);\n  });\n\n  const yMean = mean(y);\n  const yVar = variance(y);\n  let weightSum = 0;\n  let s0 = 0;\n  let s1 = 0;\n  let s2 = 0;\n  const n = weight.length;\n  // validate y.length is the same as weight.length\n  for (let i = 0; i < n; i++) {\n    let subS2 = 0;\n    for (let j = 0; j < n; j++) {\n      weightSum += weight[i][j] * (y[i] - yMean) * (y[j] - yMean);\n      s0 += weight[i][j];\n      s1 += Math.pow(weight[i][j] + weight[j][i], 2);\n      subS2 += weight[i][j] + weight[j][i];\n    }\n    s2 += Math.pow(subS2, 2);\n  }\n  s1 = 0.5 * s1;\n\n  const moranIndex = weightSum / s0 / yVar;\n  const expectedMoranIndex = -1 / (n - 1);\n  const vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);\n  const vDen = (n - 1) * (n + 1) * (s0 * s0);\n  const vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;\n  const stdNorm = Math.sqrt(vNorm);\n  const zNorm = (moranIndex - expectedMoranIndex) / stdNorm;\n\n  return {\n    expectedMoranIndex,\n    moranIndex,\n    stdNorm,\n    zNorm,\n  };\n}\n\n/**\n * get mean of a list\n * @param {number[]} y\n * @returns {number}\n *\n */\nfunction mean(y: number[]): number {\n  let sum = 0;\n  for (const item of y) {\n    sum += item;\n  }\n  return sum / y.length;\n}\n/**\n * get variance of a list\n * @param {number[]} y\n * @returns {number}\n *\n */\nfunction variance(y: number[]): number {\n  const yMean = mean(y);\n  let sum = 0;\n  for (const item of y) {\n    sum += Math.pow(item - yMean, 2);\n  }\n  return sum / y.length;\n}\n\n/**\n * @typedef {Object} MoranIndex\n * @property {number} moranIndex the moran's Index of the observed feature set\n * @property {number} expectedMoranIndex the moran's Index of the random distribution\n * @property {number} stdNorm the standard devitaion of the random distribution\n * @property {number} zNorm the z-score of the observe samples with regard to the random distribution\n */\n\nexport { moranIndex };\nexport default moranIndex;\n"]}

package/dist/{js → cjs}/index.d.ts

@@ -1,4 +1,5 @@
-import { FeatureCollection } from "geojson";
+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,
@@ -41,7 +42,7 @@ import { FeatureCollection } from "geojson";
  *   inputField: 'CRIME',
  * });
  */
-export default function (fc: FeatureCollection<any>, options: {
+declare function moranIndex(fc: FeatureCollection<any>, options: {
     inputField: string;
     threshold?: number;
     p?: number;
@@ -54,10 +55,5 @@ export default function (fc: FeatureCollection<any>, options: {
     stdNorm: number;
     zNorm: number;
 };
-/**
- * @typedef {Object} MoranIndex
- * @property {number} moranIndex the moran's Index of the observed feature set
- * @property {number} expectedMoranIndex the moran's Index of the random distribution
- * @property {number} stdNorm the standard devitaion of the random distribution
- * @property {number} zNorm the z-score of the observe samples with regard to the random distribution
- */
+
+export { moranIndex as default, moranIndex };

package/dist/esm/index.d.mts

@@ -0,0 +1,59 @@
+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,
+ * 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 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. <-1.96) indicates a dispersed pattern.
+ *
+ * the z-score can be calculated based on a normal or random assumption.
+ *
+ * **Bibliography***
+ *
+ * 1. [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)
+ *
+ * 2. [pysal](http://pysal.readthedocs.io/en/latest/index.html)
+ *
+ * 3. Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.
+ *
+ * @name moranIndex
+ * @param {FeatureCollection<any>} fc
+ * @param {Object} options
+ * @param {string} options.inputField the property name, must contain numeric values
+ * @param {number} [options.threshold=100000] the distance threshold
+ * @param {number} [options.p=2] the Minkowski p-norm distance parameter
+ * @param {boolean} [options.binary=false] whether transfrom the distance to binary
+ * @param {number} [options.alpha=-1] the distance decay parameter
+ * @param {boolean} [options.standardization=true] wheter row standardization the distance
+ * @returns {MoranIndex}
+ * @example
+ *
+ * const bbox = [-65, 40, -63, 42];
+ * const dataset = turf.randomPoint(100, { bbox: bbox });
+ *
+ * const result = turf.moranIndex(dataset, {
+ *   inputField: 'CRIME',
+ * });
+ */
+declare function moranIndex(fc: FeatureCollection<any>, options: {
+    inputField: string;
+    threshold?: number;
+    p?: number;
+    binary?: boolean;
+    alpha?: number;
+    standardization?: boolean;
+}): {
+    moranIndex: number;
+    expectedMoranIndex: number;
+    stdNorm: number;
+    zNorm: number;
+};
+
+export { moranIndex as default, moranIndex };

package/dist/esm/index.mjs

@@ -0,0 +1,82 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { distanceWeight as spatialWeight } from "@turf/distance-weight";
+import { featureEach } from "@turf/meta";
+function moranIndex(fc, options) {
+  var _a, _b;
+  const inputField = options.inputField;
+  const threshold = options.threshold || 1e5;
+  const p = options.p || 2;
+  const binary = (_a = options.binary) != null ? _a : false;
+  const alpha = options.alpha || -1;
+  const standardization = (_b = options.standardization) != null ? _b : true;
+  const weight = spatialWeight(fc, {
+    alpha,
+    binary,
+    p,
+    standardization,
+    threshold
+  });
+  const y = [];
+  featureEach(fc, (feature) => {
+    const feaProperties = feature.properties || {};
+    y.push(feaProperties[inputField]);
+  });
+  const yMean = mean(y);
+  const yVar = variance(y);
+  let weightSum = 0;
+  let s0 = 0;
+  let s1 = 0;
+  let s2 = 0;
+  const n = weight.length;
+  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);
+      subS2 += weight[i][j] + weight[j][i];
+    }
+    s2 += Math.pow(subS2, 2);
+  }
+  s1 = 0.5 * s1;
+  const moranIndex2 = 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 = (moranIndex2 - expectedMoranIndex) / stdNorm;
+  return {
+    expectedMoranIndex,
+    moranIndex: moranIndex2,
+    stdNorm,
+    zNorm
+  };
+}
+__name(moranIndex, "moranIndex");
+function mean(y) {
+  let sum = 0;
+  for (const item of y) {
+    sum += item;
+  }
+  return sum / y.length;
+}
+__name(mean, "mean");
+function variance(y) {
+  const yMean = mean(y);
+  let sum = 0;
+  for (const item of y) {
+    sum += Math.pow(item - yMean, 2);
+  }
+  return sum / y.length;
+}
+__name(variance, "variance");
+var turf_moran_index_default = moranIndex;
+export {
+  turf_moran_index_default as default,
+  moranIndex
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { FeatureCollection } from \"geojson\";\nimport { distanceWeight as spatialWeight } from \"@turf/distance-weight\";\nimport { featureEach } from \"@turf/meta\";\n\n/**\n * Moran's I measures patterns of attribute values associated with features.\n * The method reveal whether similar values tend to occur near each other,\n * or whether high or low values are interspersed.\n *\n * Moran's I > 0 means a clusterd pattern.\n * Moran's I < 0 means a dispersed pattern.\n * Moran's I = 0 means a random pattern.\n *\n * In order to test the significance of the result. The z score is calculated.\n * A positive enough z-score (ex. >1.96) indicates clustering,\n * while a negative enough z-score (ex. <-1.96) indicates a dispersed pattern.\n *\n * the z-score can be calculated based on a normal or random assumption.\n *\n * **Bibliography***\n *\n * 1. [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)\n *\n * 2. [pysal](http://pysal.readthedocs.io/en/latest/index.html)\n *\n * 3. Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.\n *\n * @name moranIndex\n * @param {FeatureCollection<any>} fc\n * @param {Object} options\n * @param {string} options.inputField the property name, must contain numeric values\n * @param {number} [options.threshold=100000] the distance threshold\n * @param {number} [options.p=2] the Minkowski p-norm distance parameter\n * @param {boolean} [options.binary=false] whether transfrom the distance to binary\n * @param {number} [options.alpha=-1] the distance decay parameter\n * @param {boolean} [options.standardization=true] wheter row standardization the distance\n * @returns {MoranIndex}\n * @example\n *\n * const bbox = [-65, 40, -63, 42];\n * const dataset = turf.randomPoint(100, { bbox: bbox });\n *\n * const result = turf.moranIndex(dataset, {\n *   inputField: 'CRIME',\n * });\n */\n\nfunction moranIndex(\n  fc: FeatureCollection<any>,\n  options: {\n    inputField: string;\n    threshold?: number;\n    p?: number;\n    binary?: boolean;\n    alpha?: number;\n    standardization?: boolean;\n  }\n): {\n  moranIndex: number;\n  expectedMoranIndex: number;\n  stdNorm: number;\n  zNorm: number;\n} {\n  const inputField = options.inputField;\n  const threshold = options.threshold || 100000;\n  const p = options.p || 2;\n  const binary = options.binary ?? false;\n  const alpha = options.alpha || -1;\n  const standardization = options.standardization ?? true;\n\n  const weight = spatialWeight(fc, {\n    alpha,\n    binary,\n    p,\n    standardization,\n    threshold,\n  });\n\n  const y: number[] = [];\n  featureEach(fc, (feature) => {\n    const feaProperties = feature.properties || {};\n    // validate inputField exists\n    y.push(feaProperties[inputField]);\n  });\n\n  const yMean = mean(y);\n  const yVar = variance(y);\n  let weightSum = 0;\n  let s0 = 0;\n  let s1 = 0;\n  let s2 = 0;\n  const n = weight.length;\n  // validate y.length is the same as weight.length\n  for (let i = 0; i < n; i++) {\n    let subS2 = 0;\n    for (let j = 0; j < n; j++) {\n      weightSum += weight[i][j] * (y[i] - yMean) * (y[j] - yMean);\n      s0 += weight[i][j];\n      s1 += Math.pow(weight[i][j] + weight[j][i], 2);\n      subS2 += weight[i][j] + weight[j][i];\n    }\n    s2 += Math.pow(subS2, 2);\n  }\n  s1 = 0.5 * s1;\n\n  const moranIndex = weightSum / s0 / yVar;\n  const expectedMoranIndex = -1 / (n - 1);\n  const vNum = n * n * s1 - n * s2 + 3 * (s0 * s0);\n  const vDen = (n - 1) * (n + 1) * (s0 * s0);\n  const vNorm = vNum / vDen - expectedMoranIndex * expectedMoranIndex;\n  const stdNorm = Math.sqrt(vNorm);\n  const zNorm = (moranIndex - expectedMoranIndex) / stdNorm;\n\n  return {\n    expectedMoranIndex,\n    moranIndex,\n    stdNorm,\n    zNorm,\n  };\n}\n\n/**\n * get mean of a list\n * @param {number[]} y\n * @returns {number}\n *\n */\nfunction mean(y: number[]): number {\n  let sum = 0;\n  for (const item of y) {\n    sum += item;\n  }\n  return sum / y.length;\n}\n/**\n * get variance of a list\n * @param {number[]} y\n * @returns {number}\n *\n */\nfunction variance(y: number[]): number {\n  const yMean = mean(y);\n  let sum = 0;\n  for (const item of y) {\n    sum += Math.pow(item - yMean, 2);\n  }\n  return sum / y.length;\n}\n\n/**\n * @typedef {Object} MoranIndex\n * @property {number} moranIndex the moran's Index of the observed feature set\n * @property {number} expectedMoranIndex the moran's Index of the random distribution\n * @property {number} stdNorm the standard devitaion of the random distribution\n * @property {number} zNorm the z-score of the observe samples with regard to the random distribution\n */\n\nexport { moranIndex };\nexport default moranIndex;\n"],"mappings":";;;;AACA,SAAS,kBAAkB,qBAAqB;AAChD,SAAS,mBAAmB;AA6C5B,SAAS,WACP,IACA,SAaA;AA9DF;AA+DE,QAAM,aAAa,QAAQ;AAC3B,QAAM,YAAY,QAAQ,aAAa;AACvC,QAAM,IAAI,QAAQ,KAAK;AACvB,QAAM,UAAS,aAAQ,WAAR,YAAkB;AACjC,QAAM,QAAQ,QAAQ,SAAS;AAC/B,QAAM,mBAAkB,aAAQ,oBAAR,YAA2B;AAEnD,QAAM,SAAS,cAAc,IAAI;AAAA,IAC/B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,IAAc,CAAC;AACrB,cAAY,IAAI,CAAC,YAAY;AAC3B,UAAM,gBAAgB,QAAQ,cAAc,CAAC;AAE7C,MAAE,KAAK,cAAc,UAAU,CAAC;AAAA,EAClC,CAAC;AAED,QAAM,QAAQ,KAAK,CAAC;AACpB,QAAM,OAAO,SAAS,CAAC;AACvB,MAAI,YAAY;AAChB,MAAI,KAAK;AACT,MAAI,KAAK;AACT,MAAI,KAAK;AACT,QAAM,IAAI,OAAO;AAEjB,WAAS,IAAI,GAAG,IAAI,GAAG,KAAK;AAC1B,QAAI,QAAQ;AACZ,aAAS,IAAI,GAAG,IAAI,GAAG,KAAK;AAC1B,mBAAa,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,IAAI;AACrD,YAAM,OAAO,CAAC,EAAE,CAAC;AACjB,YAAM,KAAK,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC;AAC7C,eAAS,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC;AAAA,IACrC;AACA,UAAM,KAAK,IAAI,OAAO,CAAC;AAAA,EACzB;AACA,OAAK,MAAM;AAEX,QAAMA,cAAa,YAAY,KAAK;AACpC,QAAM,qBAAqB,MAAM,IAAI;AACrC,QAAM,OAAO,IAAI,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK;AAC7C,QAAM,QAAQ,IAAI,MAAM,IAAI,MAAM,KAAK;AACvC,QAAM,QAAQ,OAAO,OAAO,qBAAqB;AACjD,QAAM,UAAU,KAAK,KAAK,KAAK;AAC/B,QAAM,SAASA,cAAa,sBAAsB;AAElD,SAAO;AAAA,IACL;AAAA,IACA,YAAAA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAxES;AAgFT,SAAS,KAAK,GAAqB;AACjC,MAAI,MAAM;AACV,aAAW,QAAQ,GAAG;AACpB,WAAO;AAAA,EACT;AACA,SAAO,MAAM,EAAE;AACjB;AANS;AAaT,SAAS,SAAS,GAAqB;AACrC,QAAM,QAAQ,KAAK,CAAC;AACpB,MAAI,MAAM;AACV,aAAW,QAAQ,GAAG;AACpB,WAAO,KAAK,IAAI,OAAO,OAAO,CAAC;AAAA,EACjC;AACA,SAAO,MAAM,EAAE;AACjB;AAPS;AAkBT,IAAO,2BAAQ;","names":["moranIndex"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/moran-index",
-  "version": "7.0.0-alpha.0",
+  "version": "7.0.0-alpha.110+1411d63a7",
   "description": "turf moran-index module",
   "author": "Turf Authors",
   "contributors": [
@@ -23,45 +23,51 @@
     "turf",
     "moran-index"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "commonjs",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node 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",
-    "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@types/tape": "*",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "ts-node": "*",
-    "tslint": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/distance-weight": "^7.0.0-alpha.0",
-    "@turf/helpers": "^7.0.0-alpha.0",
-    "@turf/meta": "^7.0.0-alpha.0",
-    "tslib": "^2.3.0"
+    "@turf/distance-weight": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/helpers": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/meta": "^7.0.0-alpha.110+1411d63a7",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
+  "gitHead": "1411d63a74c275c9216fe48e9d3cb2d48a359068"
 }

package/dist/es/index.js

@@ -1,131 +0,0 @@
-import spatialWeight from "@turf/distance-weight";
-import { featureEach } from "@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,
- * 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 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. <-1.96) indicates a dispersed pattern.
- *
- * the z-score can be calculated based on a normal or random assumption.
- *
- * **Bibliography***
- *
- * 1. [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)
- *
- * 2. [pysal](http://pysal.readthedocs.io/en/latest/index.html)
- *
- * 3. Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.
- *
- * @name moranIndex
- * @param {FeatureCollection<any>} fc
- * @param {Object} options
- * @param {string} options.inputField the property name, must contain numeric values
- * @param {number} [options.threshold=100000] the distance threshold
- * @param {number} [options.p=2] the Minkowski p-norm distance parameter
- * @param {boolean} [options.binary=false] whether transfrom the distance to binary
- * @param {number} [options.alpha=-1] the distance decay parameter
- * @param {boolean} [options.standardization=true] wheter row standardization the distance
- * @returns {MoranIndex}
- * @example
- *
- * const bbox = [-65, 40, -63, 42];
- * const dataset = turf.randomPoint(100, { bbox: bbox });
- *
- * const result = turf.moranIndex(dataset, {
- *   inputField: 'CRIME',
- * });
- */
-export default function (fc, options) {
-    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,
-    });
-    const y = [];
-    featureEach(fc, (feature) => {
-        const feaProperties = feature.properties || {};
-        // validate inputField exists
-        y.push(feaProperties[inputField]);
-    });
-    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 (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);
-            subS2 += weight[i][j] + weight[j][i];
-        }
-        s2 += Math.pow(subS2, 2);
-    }
-    s1 = 0.5 * s1;
-    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,
-        moranIndex,
-        stdNorm,
-        zNorm,
-    };
-}
-/**
- * get mean of a list
- * @param {number[]} y
- * @returns {number}
- *
- */
-function mean(y) {
-    let sum = 0;
-    for (const item of y) {
-        sum += item;
-    }
-    return sum / y.length;
-}
-/**
- * get variance of a list
- * @param {number[]} y
- * @returns {number}
- *
- */
-function variance(y) {
-    const yMean = mean(y);
-    let sum = 0;
-    for (const item of y) {
-        sum += Math.pow(item - yMean, 2);
-    }
-    return sum / y.length;
-}
-/**
- * @typedef {Object} MoranIndex
- * @property {number} moranIndex the moran's Index of the observed feature set
- * @property {number} expectedMoranIndex the moran's Index of the random distribution
- * @property {number} stdNorm the standard devitaion of the random distribution
- * @property {number} zNorm the z-score of the observe samples with regard to the random distribution
- */

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,135 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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,
- * 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 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. <-1.96) indicates a dispersed pattern.
- *
- * the z-score can be calculated based on a normal or random assumption.
- *
- * **Bibliography***
- *
- * 1. [Moran's I](https://en.wikipedia.org/wiki/Moran%27s_I)
- *
- * 2. [pysal](http://pysal.readthedocs.io/en/latest/index.html)
- *
- * 3. Andy Mitchell, The ESRI Guide to GIS Analysis Volume 2: Spatial Measurements & Statistics.
- *
- * @name moranIndex
- * @param {FeatureCollection<any>} fc
- * @param {Object} options
- * @param {string} options.inputField the property name, must contain numeric values
- * @param {number} [options.threshold=100000] the distance threshold
- * @param {number} [options.p=2] the Minkowski p-norm distance parameter
- * @param {boolean} [options.binary=false] whether transfrom the distance to binary
- * @param {number} [options.alpha=-1] the distance decay parameter
- * @param {boolean} [options.standardization=true] wheter row standardization the distance
- * @returns {MoranIndex}
- * @example
- *
- * const bbox = [-65, 40, -63, 42];
- * const dataset = turf.randomPoint(100, { bbox: bbox });
- *
- * const result = turf.moranIndex(dataset, {
- *   inputField: 'CRIME',
- * });
- */
-function default_1(fc, options) {
-    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,
-    });
-    const y = [];
-    meta_1.featureEach(fc, (feature) => {
-        const feaProperties = feature.properties || {};
-        // validate inputField exists
-        y.push(feaProperties[inputField]);
-    });
-    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 (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);
-            subS2 += weight[i][j] + weight[j][i];
-        }
-        s2 += Math.pow(subS2, 2);
-    }
-    s1 = 0.5 * s1;
-    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,
-        moranIndex,
-        stdNorm,
-        zNorm,
-    };
-}
-exports.default = default_1;
-/**
- * get mean of a list
- * @param {number[]} y
- * @returns {number}
- *
- */
-function mean(y) {
-    let sum = 0;
-    for (const item of y) {
-        sum += item;
-    }
-    return sum / y.length;
-}
-/**
- * get variance of a list
- * @param {number[]} y
- * @returns {number}
- *
- */
-function variance(y) {
-    const yMean = mean(y);
-    let sum = 0;
-    for (const item of y) {
-        sum += Math.pow(item - yMean, 2);
-    }
-    return sum / y.length;
-}
-/**
- * @typedef {Object} MoranIndex
- * @property {number} moranIndex the moran's Index of the observed feature set
- * @property {number} expectedMoranIndex the moran's Index of the random distribution
- * @property {number} stdNorm the standard devitaion of the random distribution
- * @property {number} zNorm the z-score of the observe samples with regard to the random distribution
- */