@turf/nearest-neighbor-analysis 7.1.0-alpha.7 → 7.1.0-alpha.70

package/README.md

@@ -22,18 +22,16 @@ dispersed.
 **Remarks**
 
 *   Though the analysis will work on any [FeatureCollection][3] type, it
-
-works best with [Point][4] collections.
+    works best with [Point][4] collections.
 
 *   This analysis is *very* sensitive to the study area provided.
-
-If no [Feature\<Polygon>][1] 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.
+    If no [Feature\<Polygon>][1] 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**
 
@@ -43,12 +41,12 @@ Measure of Spatial Relationships in Populations,” *Ecology* 35, no. 4
 
 ### Parameters
 
-*   `dataset` **[FeatureCollection][6]\<any>** FeatureCollection (pref. of points) to study
-*   `options` **[Object][7]** Optional parameters (optional, default `{}`)
+*   `dataset` **[FeatureCollection][3]\<any>** FeatureCollection (pref. of points) to study
+*   `options` **[Object][6]** Optional parameters (optional, default `{}`)
 
-    *   `options.studyArea` **[Feature][8]<[Polygon][9]>?** polygon representing the study area
-    *   `options.units` **[string][10]** unit of measurement for distances and, squared, area. (optional, default `'kilometers'`)
-    *   `options.properties` **[Object][7]** properties (optional, default `{}`)
+    *   `options.studyArea` **[Feature][7]<[Polygon][8]>?** polygon representing the study area
+    *   `options.units` **[string][9]** unit of measurement for distances and, squared, area. (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][6]** properties (optional, default `{}`)
 
 ### Examples
 
@@ -61,7 +59,7 @@ var nearestNeighborStudyArea = turf.nearestNeighborAnalysis(dataset);
 var addToMap = [dataset, nearestNeighborStudyArea];
 ```
 
-Returns **[Feature][8]<[Polygon][9]>** A polygon of the study area or an approximation of one.
+Returns **[Feature][7]<[Polygon][8]>** A polygon of the study area or an approximation of one.
 
 [1]: Feature<Polygon>
 
@@ -73,15 +71,13 @@ Returns **[Feature][8]<[Polygon][9]>** A polygon of the study area or an approxi
 
 [5]: http://doi.org/10.2307/1931034
 
-[6]: https://tools.ietf.org/html/rfc7946#section-3.3
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[8]: https://tools.ietf.org/html/rfc7946#section-3.2
+[7]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[9]: 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 of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/nearest-neighbor-analysis",
-  "version": "7.1.0-alpha.7+0ce6ecca0",
+  "version": "7.1.0-alpha.70+948cdafaf",
   "description": "turf nearest-neighbor-analysis module",
   "author": "Turf Authors",
   "contributors": [
@@ -52,7 +52,7 @@
     "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@turf/truncate": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/truncate": "^7.1.0-alpha.70+948cdafaf",
     "@types/benchmark": "^2.1.5",
     "@types/tape": "^4.2.32",
     "benchmark": "^2.1.4",
@@ -65,15 +65,16 @@
     "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/area": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/bbox": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/bbox-polygon": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/centroid": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/distance": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/meta": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/nearest-point": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/area": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/bbox": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/bbox-polygon": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/centroid": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/distance": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/helpers": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/meta": "^7.1.0-alpha.70+948cdafaf",
+    "@turf/nearest-point": "^7.1.0-alpha.70+948cdafaf",
+    "@types/geojson": "^7946.0.10",
     "tslib": "^2.6.2"
   },
-  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
+  "gitHead": "948cdafaf70606d2e27fcc79973fa48ee1182067"
 }