Merge pull request #58 from Spatiotemporal-Exposures-and-Toxicology/0…

….4dev 0.4.0 README update
NIEHS · Feb 22, 2024 · 409b6bf · 409b6bf
2 parents e14c38e + 7246cd9
commit 409b6bf
Show file tree

Hide file tree

Showing 16 changed files with 154 additions and 207 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -40,14 +40,14 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
     - Collected **datasets they need**
 
 ### Notes on data restrictions
-- This package works best with **two-dimensional** (**planar**) geometries. Users should disable `s2` spherical geometry mode in `sf` by setting
+- This package works best with **two-dimensional** (**planar**) geometries. Users should disable `s2` spherical geometry mode in `sf` by setting. Running any `chopin` functions at spherical or three-dimensional (e.g., including M/Z dimensions) geometries may produce incorrect or unexpected results.
 ```r
 sf::sf_use_s2(FALSE)
 ```
 
 ## Basic design
 - Processing functions accept [sf](https://github.com/r-spatial/sf)/[terra](https://github.com/rspatial/terra)'s classes for spatial data. Raster-vector overlay is done with `exactextractr`.
-- As of version 0.3.0, this package supports three basic functions that are readily parallelized over multithread environments:
+- This package supports three basic functions that are readily parallelized over multithread environments:
     - `extract_at`: extract raster values with point buffers or polygons.
         - `extract_at_buffer`
         - `extract_at_poly`

diff --git a/README.md b/README.md
diff --git a/figure/generate-compregion-1.png b/figure/generate-compregion-1.png
diff --git a/figure/load-srtm-1.png b/figure/load-srtm-1.png
diff --git a/figure/point-generation-1.png b/figure/point-generation-1.png
diff --git a/figure/unnamed-chunk-3-1.png b/figure/unnamed-chunk-3-1.png
diff --git a/figure/vis-results-1.png b/figure/vis-results-1.png
diff --git a/figure/vis-results-2.png b/figure/vis-results-2.png
diff --git a/man/figures/README-compare-compregions-1.png b/man/figures/README-compare-compregions-1.png
diff --git a/man/figures/README-gen-ncpoints-1.png b/man/figures/README-gen-ncpoints-1.png
diff --git a/man/figures/README-load-srtm-1.png b/man/figures/README-load-srtm-1.png
diff --git a/man/figures/README-map-all-1.png b/man/figures/README-map-all-1.png
diff --git a/man/figures/README-plot results-1.png b/man/figures/README-plot results-1.png
diff --git a/man/figures/README-plot results-2.png b/man/figures/README-plot results-2.png
diff --git a/man/figures/README-read-nc-1.png b/man/figures/README-read-nc-1.png
diff --git a/tools/readme-source/README.Rmd b/tools/readme-source/README.Rmd
@@ -40,7 +40,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
     - Collected **datasets they need**
 
 ### Notes on data restrictions
-- This package works best with **two-dimensional** (**planar**) geometries. Users should disable `s2` spherical geometry mode in `sf` by setting
+- This package works best with **two-dimensional** (**planar**) geometries. Users should disable `s2` spherical geometry mode in `sf` by setting. Running any `chopin` functions at spherical or three-dimensional (e.g., including M/Z dimensions) geometries may produce incorrect or unexpected results.
 ```r
 sf::sf_use_s2(FALSE)
 ```