AtlasOfLivingAustralia / galah-R

Query living atlases from R
https://galah.ala.org.au
39 stars 3 forks source link

Update `galah_geolocate` documentation (& functionality?) #125

Closed daxkellie closed 1 year ago

daxkellie commented 2 years ago

It might not be clear to users how to use a shapefile with galah_geolocate or how to edit that shape file using the sf package to make it work with galah_geolocate. For example, often shape files are too complex for galah_geolocate, and so it would be worth explaning how to deal with this error with information like:

# If your polygon is too complex, simplify with st_simplify()
library(sf)
sf::sf_use_s2(FALSE)
map <- sf::read_sf("victoria.shp")
map_simplified <- sf::st_simplify(map, dTolerance = 0.05)
mjwestgate commented 2 years ago

galah_geolocate hasn't had much attention, but could probably use some. A few potentially worthwhile improvements might include:

mjwestgate commented 2 years ago

Discussion 2022-02-08 led to following proposal:

One final option (not discussed) is to retain galah_geolocate as a wrapper function to the above arguments. Unclear whether this would be more or less confusing for users.

It would also be good to have a post on ALA labs site (forthcoming) to explain sensible workflows to users

mjwestgate commented 1 year ago

completed with galah_bbox and galah_polygon