Updated readme

jhollist · Jun 16, 2023 · 634edb4 · 634edb4
1 parent 6f0b0c8
commit 634edb4
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 14 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -16,8 +16,8 @@ The `elevatr` package currently provides access to elevation data from AWS Open
 
 Currently this package includes just two primary functions to access elevation web services:
 
-- `get_elev_point()`:  Get point elevations using the USGS Elevation Point Query Service (for the US Only) or using the AWS Terrian Tiles (global).  This will accept a data frame of x (long) and y (lat), a SpatialPoints/SpatialPointsDataFame, or a Simple Features object as input.  A SpatialPointsDataFrame or Simple Features object is returned, depending on the class of the input locations.
-- `get_elev_raster()`: Get elevation data as a raster (e.g. a Digital Elevation Model) from the AWS Open Data Terrain Tiles.  Other sources may be added later.  This will accept a data frame of of x (long) and y (lat) or any `sp` or `raster` object as input and will return a `raster` object of the elevation tiles that cover the bounding box of the input spatial data. 
+- `get_elev_point()`:  Get point elevations using the USGS Elevation Point Query Service (for the US Only) or using the AWS Terrain Tiles (global).  This will accept a data frame of x (long) and y (lat), a Simple Features object, or `terra` SpatRaster as input.  A Simple Features object is returned of the point locations and elevations.
+- `get_elev_raster()`: Get elevation data as a raster (e.g. a Digital Elevation Model) from the AWS Open Data Terrain Tiles or Open Topography Global datasets.  Other sources may be added later.  This will accept a data frame of of x (long) and y (lat) or any `sf` or `terra` SpatRaster object as input and will return a terra `SpatRaster` object of the elevation.  The extent of the SpatRaster is the full tiles that cover the bounding box of the input spatial data, but may be clipped to the shape or bounding box of the input locations. 
 
 ## Installation
 
@@ -33,13 +33,17 @@ Version `r version` of this package is currently available from CRAN and may be
 install.packages("elevatr")
 ```
 
+NOTE: As of `r lubridate::today()`, the CRAN version is the older version that does not support `terra`.
+
 The development version (this repo) may installed with `devtools`:
 
 ```{r, eval=F}
 library(devtools)
 install_github("jhollist/elevatr")
 ```
 
+NOTE: As of `r lubridate::today()`, the development version on GitHub, `r packageVersion("elevatr")`, is the latest version and supports `sf` and `terra`.  Support for `sp` and `raster` has been deprecated.
+
 ## Contributions and Use Cases
 
 As `elevatr` is getting more widely used, there have been some great contributions, use cases, and additional packages that have come from the user community.  If you have one you'd like to share, let me know and I will gladly add it.  Here are some of the ones that I have seen.  Thank you all!

diff --git a/README.md b/README.md
@@ -26,34 +26,43 @@ Currently this package includes just two primary functions to access
 elevation web services:
 
 - `get_elev_point()`: Get point elevations using the USGS Elevation
-  Point Query Service (for the US Only) or using the AWS Terrian Tiles
+  Point Query Service (for the US Only) or using the AWS Terrain Tiles
   (global). This will accept a data frame of x (long) and y (lat), a
-  SpatialPoints/SpatialPointsDataFame, or a Simple Features object as
-  input. A SpatialPointsDataFrame or Simple Features object is returned,
-  depending on the class of the input locations.
+  Simple Features object, or `terra` SpatRaster as input. A Simple
+  Features object is returned of the point locations and elevations.
 - `get_elev_raster()`: Get elevation data as a raster (e.g. a Digital
-  Elevation Model) from the AWS Open Data Terrain Tiles. Other sources
-  may be added later. This will accept a data frame of of x (long) and y
-  (lat) or any `sp` or `raster` object as input and will return a
-  `raster` object of the elevation tiles that cover the bounding box of
-  the input spatial data.
+  Elevation Model) from the AWS Open Data Terrain Tiles or Open
+  Topography Global datasets. Other sources may be added later. This
+  will accept a data frame of of x (long) and y (lat) or any `sf` or
+  `terra` SpatRaster object as input and will return a terra
+  `SpatRaster` object of the elevation. The extent of the SpatRaster is
+  the full tiles that cover the bounding box of the input spatial data,
+  but may be clipped to the shape or bounding box of the input
+  locations.
 
 ## Installation
 
-Version 0.4.2 of this package is currently available from CRAN and may
+Version 0.4.5 of this package is currently available from CRAN and may
 be installed by:
 
 ``` r
 install.packages("elevatr")
 ```
 
+NOTE: As of 2023-06-16, the CRAN version is the older version that does
+not support `terra`.
+
 The development version (this repo) may installed with `devtools`:
 
 ``` r
 library(devtools)
 install_github("jhollist/elevatr")
 ```
 
+NOTE: As of 2023-06-16, the development version on GitHub, 1.0.0.9999,
+is the latest version and supports `sf` and `terra`. Support for `sp`
+and `raster` has been deprecated.
+
 ## Contributions and Use Cases
 
 As `elevatr` is getting more widely used, there have been some great
@@ -64,8 +73,7 @@ you all!
 
 - [Michaela Mulhearn’s `rayshader` and `elevatr`
   cheatsheet](https://github.com/jhollist/elevatr/blob/main/contributions/mulhearn_rayshader_elevatr_cheatsheet.pdf)
-- researchremora on twitter has created some amazing elevation
-  maps
+- researchremora on twitter has created some amazing elevation maps
 - [Hugh Graham’s `rayvista` package uses `rayshader`, `maptiles`, and
   `elevatr` to create some cool
   visualizations](https://github.com/h-a-graham/rayvista)