@turf/nearest-neighbor-analysis 7.0.0-alpha.1 → 7.0.0-alpha.111

package/README.md

@@ -83,26 +83,21 @@ Returns **[Feature][8]<[Polygon][9]>** A polygon of the study area or an approxi
 
 [10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-<!-- 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/nearest-neighbor-analysis
 ```
 
-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,61 @@
+"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 _area = require('@turf/area');
+var _bbox = require('@turf/bbox');
+var _bboxpolygon = require('@turf/bbox-polygon');
+var _centroid = require('@turf/centroid');
+var _distance = require('@turf/distance');
+var _nearestpoint = require('@turf/nearest-point');
+var _meta = require('@turf/meta');
+
+
+
+var _helpers = require('@turf/helpers');
+function nearestNeighborAnalysis(dataset, options) {
+  options = options || {};
+  const studyArea = options.studyArea || _bboxpolygon.bboxPolygon.call(void 0, _bbox.bbox.call(void 0, dataset));
+  const properties = options.properties || {};
+  const units = options.units || "kilometers";
+  const features = [];
+  _meta.featureEach.call(void 0, dataset, (feature) => {
+    features.push(_centroid.centroid.call(void 0, feature));
+  });
+  const n = features.length;
+  const observedMeanDistance = features.map((feature, index) => {
+    const otherFeatures = _helpers.featureCollection.call(void 0, 
+      features.filter((f, i) => {
+        return i !== index;
+      })
+    );
+    return _distance.distance.call(void 0, 
+      feature,
+      _nearestpoint.nearestPoint.call(void 0, feature, otherFeatures).geometry.coordinates,
+      { units }
+    );
+  }).reduce((sum, value) => {
+    return sum + value;
+  }, 0) / n;
+  const populationDensity = n / _helpers.convertArea.call(void 0, _area.area.call(void 0, studyArea), "meters", units);
+  const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));
+  const variance = 0.26136 / Math.sqrt(n * populationDensity);
+  properties.nearestNeighborAnalysis = {
+    units,
+    arealUnits: units + "\xB2",
+    observedMeanDistance,
+    expectedMeanDistance,
+    nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,
+    numberOfPoints: n,
+    zScore: (observedMeanDistance - expectedMeanDistance) / variance
+  };
+  studyArea.properties = properties;
+  return studyArea;
+}
+__name(nearestNeighborAnalysis, "nearestNeighborAnalysis");
+var turf_nearest_neighbor_analysis_default = nearestNeighborAnalysis;
+
+
+
+exports.default = turf_nearest_neighbor_analysis_default; exports.nearestNeighborAnalysis = nearestNeighborAnalysis;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AAOA,SAAS,YAAY;AACrB,SAAS,YAAY;AACrB,SAAS,mBAAmB;AAC5B,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AACzB,SAAS,oBAAoB;AAC7B,SAAS,mBAAmB;AAC5B;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AAqEP,SAAS,wBACP,SACA,SAK0B;AAE1B,YAAU,WAAW,CAAC;AACtB,QAAM,YAAY,QAAQ,aAAa,YAAY,KAAK,OAAO,CAAC;AAChE,QAAM,aAAa,QAAQ,cAAc,CAAC;AAC1C,QAAM,QAAQ,QAAQ,SAAS;AAE/B,QAAM,WAAkC,CAAC;AACzC,cAAY,SAAS,CAAC,YAAY;AAChC,aAAS,KAAK,SAAS,OAAO,CAAC;AAAA,EACjC,CAAC;AACD,QAAM,IAAI,SAAS;AACnB,QAAM,uBACJ,SACG,IAAI,CAAC,SAAS,UAAU;AACvB,UAAM,gBAAgB;AAAA,MACpB,SAAS,OAAO,CAAC,GAAG,MAAM;AACxB,eAAO,MAAM;AAAA,MACf,CAAC;AAAA,IACH;AAGA,WAAO;AAAA,MACL;AAAA,MACA,aAAa,SAAS,aAAa,EAAE,SAAU;AAAA,MAC/C,EAAE,MAAM;AAAA,IACV;AAAA,EACF,CAAC,EACA,OAAO,CAAC,KAAK,UAAU;AACtB,WAAO,MAAM;AAAA,EACf,GAAG,CAAC,IAAI;AAEZ,QAAM,oBAAoB,IAAI,YAAY,KAAK,SAAS,GAAG,UAAU,KAAK;AAC1E,QAAM,uBAAuB,KAAK,IAAI,KAAK,KAAK,iBAAiB;AACjE,QAAM,WAAW,UAAU,KAAK,KAAK,IAAI,iBAAiB;AAC1D,aAAW,0BAA0B;AAAA,IACnC;AAAA,IACA,YAAY,QAAQ;AAAA,IACpB;AAAA,IACA;AAAA,IACA,sBAAsB,uBAAuB;AAAA,IAC7C,gBAAgB;AAAA,IAChB,SAAS,uBAAuB,wBAAwB;AAAA,EAC1D;AACA,YAAU,aAAa;AAEvB,SAAO;AACT;AAtDS;AA6DT,IAAO,yCAAQ","sourcesContent":["import {\n  FeatureCollection,\n  Feature,\n  Point,\n  Polygon,\n  GeoJsonProperties,\n} from \"geojson\";\nimport { area } from \"@turf/area\";\nimport { bbox } from \"@turf/bbox\";\nimport { bboxPolygon } from \"@turf/bbox-polygon\";\nimport { centroid } from \"@turf/centroid\";\nimport { distance } from \"@turf/distance\";\nimport { nearestPoint } from \"@turf/nearest-point\";\nimport { featureEach } from \"@turf/meta\";\nimport {\n  convertArea,\n  featureCollection,\n  Units,\n  AreaUnits,\n} from \"@turf/helpers\";\n\ninterface NearestNeighborStatistics {\n  units: Units & AreaUnits;\n  arealUnits: string;\n  observedMeanDistance: number;\n  expectedMeanDistance: number;\n  numberOfPoints: number;\n  zScore: number;\n}\n\ninterface NearestNeighborStudyArea extends Feature<Polygon> {\n  properties: {\n    nearestNeighborAnalysis: NearestNeighborStatistics;\n    [key: string]: any;\n  };\n}\n\n/**\n * Nearest Neighbor Analysis calculates an index based the average distances\n * between points in the dataset, thereby providing inference as to whether the\n * data is clustered, dispersed, or randomly distributed within the study area.\n *\n * It returns a {@link Feature<Polygon>} of the study area, with the results of\n * the analysis attached as part of of the `nearestNeighborAnalysis` property\n * of the study area's `properties`. The attached\n * [_z_-score](https://en.wikipedia.org/wiki/Standard_score) indicates how many\n * standard deviations above or below the expected mean distance the data's\n * observed mean distance is. The more negative, the more clustered. The more\n * positive, the more evenly dispersed. A _z_-score between -2 and 2 indicates\n * a seemingly random distribution. That is, within _p_ of less than 0.05, the\n * distribution appears statistically significantly neither clustered nor\n * dispersed.\n *\n * **Remarks**\n *\n * - Though the analysis will work on any {@link FeatureCollection} type, it\n * works best with {@link Point} collections.\n *\n * - This analysis is _very_ sensitive to the study area provided.\n * If no {@link Feature<Polygon>} is passed as the study area, the function draws a box\n * around the data, which may distort the findings. This analysis works best\n * with a bounded area of interest within with the data is either clustered,\n * dispersed, or randomly distributed. For example, a city's subway stops may\n * look extremely clustered if the study area is an entire state. On the other\n * hand, they may look rather evenly dispersed if the study area is limited to\n * the city's downtown.\n *\n * **Bibliography**\n *\n * Philip J. Clark and Francis C. Evans, “Distance to Nearest Neighbor as a\n * Measure of Spatial Relationships in Populations,” _Ecology_ 35, no. 4\n * (1954): 445–453, doi:[10.2307/1931034](http://doi.org/10.2307/1931034).\n *\n * @name nearestNeighborAnalysis\n * @param {FeatureCollection<any>} dataset FeatureCollection (pref. of points) to study\n * @param {Object} [options={}] Optional parameters\n * @param {Feature<Polygon>} [options.studyArea] polygon representing the study area\n * @param {string} [options.units='kilometers'] unit of measurement for distances and, squared, area.\n * @param {Object} [options.properties={}] properties\n * @returns {Feature<Polygon>} A polygon of the study area or an approximation of one.\n * @example\n * var bbox = [-65, 40, -63, 42];\n * var dataset = turf.randomPoint(100, { bbox: bbox });\n * var nearestNeighborStudyArea = turf.nearestNeighborAnalysis(dataset);\n *\n * //addToMap\n * var addToMap = [dataset, nearestNeighborStudyArea];\n */\nfunction nearestNeighborAnalysis(\n  dataset: FeatureCollection<any>,\n  options?: {\n    studyArea?: Feature<Polygon>;\n    units?: Units & AreaUnits;\n    properties?: GeoJsonProperties;\n  }\n): NearestNeighborStudyArea {\n  // Optional params\n  options = options || {};\n  const studyArea = options.studyArea || bboxPolygon(bbox(dataset));\n  const properties = options.properties || {};\n  const units = options.units || \"kilometers\";\n\n  const features: Array<Feature<Point>> = [];\n  featureEach(dataset, (feature) => {\n    features.push(centroid(feature));\n  });\n  const n = features.length;\n  const observedMeanDistance =\n    features\n      .map((feature, index) => {\n        const otherFeatures = featureCollection<Point>(\n          features.filter((f, i) => {\n            return i !== index;\n          })\n        );\n        // Have to add the ! to make typescript validation pass\n        // see https://stackoverflow.com/a/40350534/1979085\n        return distance(\n          feature,\n          nearestPoint(feature, otherFeatures).geometry!.coordinates,\n          { units }\n        );\n      })\n      .reduce((sum, value) => {\n        return sum + value;\n      }, 0) / n;\n\n  const populationDensity = n / convertArea(area(studyArea), \"meters\", units);\n  const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));\n  const variance = 0.26136 / Math.sqrt(n * populationDensity);\n  properties.nearestNeighborAnalysis = {\n    units: units,\n    arealUnits: units + \"²\",\n    observedMeanDistance: observedMeanDistance,\n    expectedMeanDistance: expectedMeanDistance,\n    nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,\n    numberOfPoints: n,\n    zScore: (observedMeanDistance - expectedMeanDistance) / variance,\n  };\n  studyArea.properties = properties;\n\n  return studyArea as NearestNeighborStudyArea;\n}\n\nexport {\n  nearestNeighborAnalysis,\n  NearestNeighborStatistics,\n  NearestNeighborStudyArea,\n};\nexport default nearestNeighborAnalysis;\n"]}

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

@@ -1,6 +1,7 @@
-import { FeatureCollection, Feature, Polygon, GeoJsonProperties } from "geojson";
-import { Units, AreaUnits } from "@turf/helpers";
-export interface NearestNeighborStatistics {
+import { Feature, Polygon, FeatureCollection, GeoJsonProperties } from 'geojson';
+import { Units, AreaUnits } from '@turf/helpers';
+
+interface NearestNeighborStatistics {
     units: Units & AreaUnits;
     arealUnits: string;
     observedMeanDistance: number;
@@ -8,7 +9,7 @@ export interface NearestNeighborStatistics {
     numberOfPoints: number;
     zScore: number;
 }
-export interface NearestNeighborStudyArea extends Feature<Polygon> {
+interface NearestNeighborStudyArea extends Feature<Polygon> {
     properties: {
         nearestNeighborAnalysis: NearestNeighborStatistics;
         [key: string]: any;
@@ -70,4 +71,5 @@ declare function nearestNeighborAnalysis(dataset: FeatureCollection<any>, option
     units?: Units & AreaUnits;
     properties?: GeoJsonProperties;
 }): NearestNeighborStudyArea;
-export default nearestNeighborAnalysis;
+
+export { type NearestNeighborStatistics, type NearestNeighborStudyArea, nearestNeighborAnalysis as default, nearestNeighborAnalysis };

package/dist/{es/index.js → esm/index.d.mts}

@@ -1,11 +1,20 @@
-import area from "@turf/area";
-import bbox from "@turf/bbox";
-import bboxPolygon from "@turf/bbox-polygon";
-import centroid from "@turf/centroid";
-import distance from "@turf/distance";
-import nearestPoint from "@turf/nearest-point";
-import { featureEach } from "@turf/meta";
-import { convertArea, featureCollection, } from "@turf/helpers";
+import { Feature, Polygon, FeatureCollection, GeoJsonProperties } from 'geojson';
+import { Units, AreaUnits } from '@turf/helpers';
+
+interface NearestNeighborStatistics {
+    units: Units & AreaUnits;
+    arealUnits: string;
+    observedMeanDistance: number;
+    expectedMeanDistance: number;
+    numberOfPoints: number;
+    zScore: number;
+}
+interface NearestNeighborStudyArea extends Feature<Polygon> {
+    properties: {
+        nearestNeighborAnalysis: NearestNeighborStatistics;
+        [key: string]: any;
+    };
+}
 /**
  * Nearest Neighbor Analysis calculates an index based the average distances
  * between points in the dataset, thereby providing inference as to whether the
@@ -57,42 +66,10 @@ import { convertArea, featureCollection, } from "@turf/helpers";
  * //addToMap
  * var addToMap = [dataset, nearestNeighborStudyArea];
  */
-function nearestNeighborAnalysis(dataset, options) {
-    // Optional params
-    options = options || {};
-    const studyArea = options.studyArea || bboxPolygon(bbox(dataset));
-    const properties = options.properties || {};
-    const units = options.units || "kilometers";
-    const features = [];
-    featureEach(dataset, (feature) => {
-        features.push(centroid(feature));
-    });
-    const n = features.length;
-    const observedMeanDistance = features
-        .map((feature, index) => {
-        const otherFeatures = featureCollection(features.filter((f, i) => {
-            return i !== index;
-        }));
-        // Have to add the ! to make typescript validation pass
-        // see https://stackoverflow.com/a/40350534/1979085
-        return distance(feature, nearestPoint(feature, otherFeatures).geometry.coordinates, { units });
-    })
-        .reduce((sum, value) => {
-        return sum + value;
-    }, 0) / n;
-    const populationDensity = n / convertArea(area(studyArea), "meters", units);
-    const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));
-    const variance = 0.26136 / Math.sqrt(n * populationDensity);
-    properties.nearestNeighborAnalysis = {
-        units: units,
-        arealUnits: units + "²",
-        observedMeanDistance: observedMeanDistance,
-        expectedMeanDistance: expectedMeanDistance,
-        nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,
-        numberOfPoints: n,
-        zScore: (observedMeanDistance - expectedMeanDistance) / variance,
-    };
-    studyArea.properties = properties;
-    return studyArea;
-}
-export default nearestNeighborAnalysis;
+declare function nearestNeighborAnalysis(dataset: FeatureCollection<any>, options?: {
+    studyArea?: Feature<Polygon>;
+    units?: Units & AreaUnits;
+    properties?: GeoJsonProperties;
+}): NearestNeighborStudyArea;
+
+export { type NearestNeighborStatistics, type NearestNeighborStudyArea, nearestNeighborAnalysis as default, nearestNeighborAnalysis };

package/dist/esm/index.mjs

@@ -0,0 +1,61 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { area } from "@turf/area";
+import { bbox } from "@turf/bbox";
+import { bboxPolygon } from "@turf/bbox-polygon";
+import { centroid } from "@turf/centroid";
+import { distance } from "@turf/distance";
+import { nearestPoint } from "@turf/nearest-point";
+import { featureEach } from "@turf/meta";
+import {
+  convertArea,
+  featureCollection
+} from "@turf/helpers";
+function nearestNeighborAnalysis(dataset, options) {
+  options = options || {};
+  const studyArea = options.studyArea || bboxPolygon(bbox(dataset));
+  const properties = options.properties || {};
+  const units = options.units || "kilometers";
+  const features = [];
+  featureEach(dataset, (feature) => {
+    features.push(centroid(feature));
+  });
+  const n = features.length;
+  const observedMeanDistance = features.map((feature, index) => {
+    const otherFeatures = featureCollection(
+      features.filter((f, i) => {
+        return i !== index;
+      })
+    );
+    return distance(
+      feature,
+      nearestPoint(feature, otherFeatures).geometry.coordinates,
+      { units }
+    );
+  }).reduce((sum, value) => {
+    return sum + value;
+  }, 0) / n;
+  const populationDensity = n / convertArea(area(studyArea), "meters", units);
+  const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));
+  const variance = 0.26136 / Math.sqrt(n * populationDensity);
+  properties.nearestNeighborAnalysis = {
+    units,
+    arealUnits: units + "\xB2",
+    observedMeanDistance,
+    expectedMeanDistance,
+    nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,
+    numberOfPoints: n,
+    zScore: (observedMeanDistance - expectedMeanDistance) / variance
+  };
+  studyArea.properties = properties;
+  return studyArea;
+}
+__name(nearestNeighborAnalysis, "nearestNeighborAnalysis");
+var turf_nearest_neighbor_analysis_default = nearestNeighborAnalysis;
+export {
+  turf_nearest_neighbor_analysis_default as default,
+  nearestNeighborAnalysis
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import {\n  FeatureCollection,\n  Feature,\n  Point,\n  Polygon,\n  GeoJsonProperties,\n} from \"geojson\";\nimport { area } from \"@turf/area\";\nimport { bbox } from \"@turf/bbox\";\nimport { bboxPolygon } from \"@turf/bbox-polygon\";\nimport { centroid } from \"@turf/centroid\";\nimport { distance } from \"@turf/distance\";\nimport { nearestPoint } from \"@turf/nearest-point\";\nimport { featureEach } from \"@turf/meta\";\nimport {\n  convertArea,\n  featureCollection,\n  Units,\n  AreaUnits,\n} from \"@turf/helpers\";\n\ninterface NearestNeighborStatistics {\n  units: Units & AreaUnits;\n  arealUnits: string;\n  observedMeanDistance: number;\n  expectedMeanDistance: number;\n  numberOfPoints: number;\n  zScore: number;\n}\n\ninterface NearestNeighborStudyArea extends Feature<Polygon> {\n  properties: {\n    nearestNeighborAnalysis: NearestNeighborStatistics;\n    [key: string]: any;\n  };\n}\n\n/**\n * Nearest Neighbor Analysis calculates an index based the average distances\n * between points in the dataset, thereby providing inference as to whether the\n * data is clustered, dispersed, or randomly distributed within the study area.\n *\n * It returns a {@link Feature<Polygon>} of the study area, with the results of\n * the analysis attached as part of of the `nearestNeighborAnalysis` property\n * of the study area's `properties`. The attached\n * [_z_-score](https://en.wikipedia.org/wiki/Standard_score) indicates how many\n * standard deviations above or below the expected mean distance the data's\n * observed mean distance is. The more negative, the more clustered. The more\n * positive, the more evenly dispersed. A _z_-score between -2 and 2 indicates\n * a seemingly random distribution. That is, within _p_ of less than 0.05, the\n * distribution appears statistically significantly neither clustered nor\n * dispersed.\n *\n * **Remarks**\n *\n * - Though the analysis will work on any {@link FeatureCollection} type, it\n * works best with {@link Point} collections.\n *\n * - This analysis is _very_ sensitive to the study area provided.\n * If no {@link Feature<Polygon>} is passed as the study area, the function draws a box\n * around the data, which may distort the findings. This analysis works best\n * with a bounded area of interest within with the data is either clustered,\n * dispersed, or randomly distributed. For example, a city's subway stops may\n * look extremely clustered if the study area is an entire state. On the other\n * hand, they may look rather evenly dispersed if the study area is limited to\n * the city's downtown.\n *\n * **Bibliography**\n *\n * Philip J. Clark and Francis C. Evans, “Distance to Nearest Neighbor as a\n * Measure of Spatial Relationships in Populations,” _Ecology_ 35, no. 4\n * (1954): 445–453, doi:[10.2307/1931034](http://doi.org/10.2307/1931034).\n *\n * @name nearestNeighborAnalysis\n * @param {FeatureCollection<any>} dataset FeatureCollection (pref. of points) to study\n * @param {Object} [options={}] Optional parameters\n * @param {Feature<Polygon>} [options.studyArea] polygon representing the study area\n * @param {string} [options.units='kilometers'] unit of measurement for distances and, squared, area.\n * @param {Object} [options.properties={}] properties\n * @returns {Feature<Polygon>} A polygon of the study area or an approximation of one.\n * @example\n * var bbox = [-65, 40, -63, 42];\n * var dataset = turf.randomPoint(100, { bbox: bbox });\n * var nearestNeighborStudyArea = turf.nearestNeighborAnalysis(dataset);\n *\n * //addToMap\n * var addToMap = [dataset, nearestNeighborStudyArea];\n */\nfunction nearestNeighborAnalysis(\n  dataset: FeatureCollection<any>,\n  options?: {\n    studyArea?: Feature<Polygon>;\n    units?: Units & AreaUnits;\n    properties?: GeoJsonProperties;\n  }\n): NearestNeighborStudyArea {\n  // Optional params\n  options = options || {};\n  const studyArea = options.studyArea || bboxPolygon(bbox(dataset));\n  const properties = options.properties || {};\n  const units = options.units || \"kilometers\";\n\n  const features: Array<Feature<Point>> = [];\n  featureEach(dataset, (feature) => {\n    features.push(centroid(feature));\n  });\n  const n = features.length;\n  const observedMeanDistance =\n    features\n      .map((feature, index) => {\n        const otherFeatures = featureCollection<Point>(\n          features.filter((f, i) => {\n            return i !== index;\n          })\n        );\n        // Have to add the ! to make typescript validation pass\n        // see https://stackoverflow.com/a/40350534/1979085\n        return distance(\n          feature,\n          nearestPoint(feature, otherFeatures).geometry!.coordinates,\n          { units }\n        );\n      })\n      .reduce((sum, value) => {\n        return sum + value;\n      }, 0) / n;\n\n  const populationDensity = n / convertArea(area(studyArea), \"meters\", units);\n  const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));\n  const variance = 0.26136 / Math.sqrt(n * populationDensity);\n  properties.nearestNeighborAnalysis = {\n    units: units,\n    arealUnits: units + \"²\",\n    observedMeanDistance: observedMeanDistance,\n    expectedMeanDistance: expectedMeanDistance,\n    nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,\n    numberOfPoints: n,\n    zScore: (observedMeanDistance - expectedMeanDistance) / variance,\n  };\n  studyArea.properties = properties;\n\n  return studyArea as NearestNeighborStudyArea;\n}\n\nexport {\n  nearestNeighborAnalysis,\n  NearestNeighborStatistics,\n  NearestNeighborStudyArea,\n};\nexport default nearestNeighborAnalysis;\n"],"mappings":";;;;AAOA,SAAS,YAAY;AACrB,SAAS,YAAY;AACrB,SAAS,mBAAmB;AAC5B,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AACzB,SAAS,oBAAoB;AAC7B,SAAS,mBAAmB;AAC5B;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AAqEP,SAAS,wBACP,SACA,SAK0B;AAE1B,YAAU,WAAW,CAAC;AACtB,QAAM,YAAY,QAAQ,aAAa,YAAY,KAAK,OAAO,CAAC;AAChE,QAAM,aAAa,QAAQ,cAAc,CAAC;AAC1C,QAAM,QAAQ,QAAQ,SAAS;AAE/B,QAAM,WAAkC,CAAC;AACzC,cAAY,SAAS,CAAC,YAAY;AAChC,aAAS,KAAK,SAAS,OAAO,CAAC;AAAA,EACjC,CAAC;AACD,QAAM,IAAI,SAAS;AACnB,QAAM,uBACJ,SACG,IAAI,CAAC,SAAS,UAAU;AACvB,UAAM,gBAAgB;AAAA,MACpB,SAAS,OAAO,CAAC,GAAG,MAAM;AACxB,eAAO,MAAM;AAAA,MACf,CAAC;AAAA,IACH;AAGA,WAAO;AAAA,MACL;AAAA,MACA,aAAa,SAAS,aAAa,EAAE,SAAU;AAAA,MAC/C,EAAE,MAAM;AAAA,IACV;AAAA,EACF,CAAC,EACA,OAAO,CAAC,KAAK,UAAU;AACtB,WAAO,MAAM;AAAA,EACf,GAAG,CAAC,IAAI;AAEZ,QAAM,oBAAoB,IAAI,YAAY,KAAK,SAAS,GAAG,UAAU,KAAK;AAC1E,QAAM,uBAAuB,KAAK,IAAI,KAAK,KAAK,iBAAiB;AACjE,QAAM,WAAW,UAAU,KAAK,KAAK,IAAI,iBAAiB;AAC1D,aAAW,0BAA0B;AAAA,IACnC;AAAA,IACA,YAAY,QAAQ;AAAA,IACpB;AAAA,IACA;AAAA,IACA,sBAAsB,uBAAuB;AAAA,IAC7C,gBAAgB;AAAA,IAChB,SAAS,uBAAuB,wBAAwB;AAAA,EAC1D;AACA,YAAU,aAAa;AAEvB,SAAO;AACT;AAtDS;AA6DT,IAAO,yCAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-neighbor-analysis",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-alpha.111+08576cb50",
   "description": "turf nearest-neighbor-analysis module",
   "author": "Turf Authors",
   "contributors": [
@@ -23,52 +23,57 @@
     "turf",
     "nearest-neighbor"
   ],
-  "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",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "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": "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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx 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": {
-    "@turf/truncate": "^7.0.0-alpha.1",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@turf/truncate": "^7.0.0-alpha.111+08576cb50",
+    "@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/area": "^7.0.0-alpha.1",
-    "@turf/bbox": "^7.0.0-alpha.1",
-    "@turf/bbox-polygon": "^7.0.0-alpha.1",
-    "@turf/centroid": "^7.0.0-alpha.1",
-    "@turf/distance": "^7.0.0-alpha.1",
-    "@turf/helpers": "^7.0.0-alpha.1",
-    "@turf/meta": "^7.0.0-alpha.1",
-    "@turf/nearest-point": "^7.0.0-alpha.1",
-    "tslib": "^2.3.0"
+    "@turf/area": "^7.0.0-alpha.111+08576cb50",
+    "@turf/bbox": "^7.0.0-alpha.111+08576cb50",
+    "@turf/bbox-polygon": "^7.0.0-alpha.111+08576cb50",
+    "@turf/centroid": "^7.0.0-alpha.111+08576cb50",
+    "@turf/distance": "^7.0.0-alpha.111+08576cb50",
+    "@turf/helpers": "^7.0.0-alpha.111+08576cb50",
+    "@turf/meta": "^7.0.0-alpha.111+08576cb50",
+    "@turf/nearest-point": "^7.0.0-alpha.111+08576cb50",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
+  "gitHead": "08576cb50376e0199aea02dbd887e3af83672246"
 }

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const area_1 = tslib_1.__importDefault(require("@turf/area"));
-const bbox_1 = tslib_1.__importDefault(require("@turf/bbox"));
-const bbox_polygon_1 = tslib_1.__importDefault(require("@turf/bbox-polygon"));
-const centroid_1 = tslib_1.__importDefault(require("@turf/centroid"));
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const nearest_point_1 = tslib_1.__importDefault(require("@turf/nearest-point"));
-const meta_1 = require("@turf/meta");
-const helpers_1 = require("@turf/helpers");
-/**
- * Nearest Neighbor Analysis calculates an index based the average distances
- * between points in the dataset, thereby providing inference as to whether the
- * data is clustered, dispersed, or randomly distributed within the study area.
- *
- * It returns a {@link Feature<Polygon>} of the study area, with the results of
- * the analysis attached as part of of the `nearestNeighborAnalysis` property
- * of the study area's `properties`. The attached
- * [_z_-score](https://en.wikipedia.org/wiki/Standard_score) indicates how many
- * standard deviations above or below the expected mean distance the data's
- * observed mean distance is. The more negative, the more clustered. The more
- * positive, the more evenly dispersed. A _z_-score between -2 and 2 indicates
- * a seemingly random distribution. That is, within _p_ of less than 0.05, the
- * distribution appears statistically significantly neither clustered nor
- * dispersed.
- *
- * **Remarks**
- *
- * - Though the analysis will work on any {@link FeatureCollection} type, it
- * works best with {@link Point} collections.
- *
- * - This analysis is _very_ sensitive to the study area provided.
- * If no {@link Feature<Polygon>} is passed as the study area, the function draws a box
- * around the data, which may distort the findings. This analysis works best
- * with a bounded area of interest within with the data is either clustered,
- * dispersed, or randomly distributed. For example, a city's subway stops may
- * look extremely clustered if the study area is an entire state. On the other
- * hand, they may look rather evenly dispersed if the study area is limited to
- * the city's downtown.
- *
- * **Bibliography**
- *
- * Philip J. Clark and Francis C. Evans, “Distance to Nearest Neighbor as a
- * Measure of Spatial Relationships in Populations,” _Ecology_ 35, no. 4
- * (1954): 445–453, doi:[10.2307/1931034](http://doi.org/10.2307/1931034).
- *
- * @name nearestNeighborAnalysis
- * @param {FeatureCollection<any>} dataset FeatureCollection (pref. of points) to study
- * @param {Object} [options={}] Optional parameters
- * @param {Feature<Polygon>} [options.studyArea] polygon representing the study area
- * @param {string} [options.units='kilometers'] unit of measurement for distances and, squared, area.
- * @param {Object} [options.properties={}] properties
- * @returns {Feature<Polygon>} A polygon of the study area or an approximation of one.
- * @example
- * var bbox = [-65, 40, -63, 42];
- * var dataset = turf.randomPoint(100, { bbox: bbox });
- * var nearestNeighborStudyArea = turf.nearestNeighborAnalysis(dataset);
- *
- * //addToMap
- * var addToMap = [dataset, nearestNeighborStudyArea];
- */
-function nearestNeighborAnalysis(dataset, options) {
-    // Optional params
-    options = options || {};
-    const studyArea = options.studyArea || bbox_polygon_1.default(bbox_1.default(dataset));
-    const properties = options.properties || {};
-    const units = options.units || "kilometers";
-    const features = [];
-    meta_1.featureEach(dataset, (feature) => {
-        features.push(centroid_1.default(feature));
-    });
-    const n = features.length;
-    const observedMeanDistance = features
-        .map((feature, index) => {
-        const otherFeatures = helpers_1.featureCollection(features.filter((f, i) => {
-            return i !== index;
-        }));
-        // Have to add the ! to make typescript validation pass
-        // see https://stackoverflow.com/a/40350534/1979085
-        return distance_1.default(feature, nearest_point_1.default(feature, otherFeatures).geometry.coordinates, { units });
-    })
-        .reduce((sum, value) => {
-        return sum + value;
-    }, 0) / n;
-    const populationDensity = n / helpers_1.convertArea(area_1.default(studyArea), "meters", units);
-    const expectedMeanDistance = 1 / (2 * Math.sqrt(populationDensity));
-    const variance = 0.26136 / Math.sqrt(n * populationDensity);
-    properties.nearestNeighborAnalysis = {
-        units: units,
-        arealUnits: units + "²",
-        observedMeanDistance: observedMeanDistance,
-        expectedMeanDistance: expectedMeanDistance,
-        nearestNeighborIndex: observedMeanDistance / expectedMeanDistance,
-        numberOfPoints: n,
-        zScore: (observedMeanDistance - expectedMeanDistance) / variance,
-    };
-    studyArea.properties = properties;
-    return studyArea;
-}
-exports.default = nearestNeighborAnalysis;