diff --git a/.github/workflows/recheck.yaml b/.github/workflows/recheck.yaml new file mode 100644 index 00000000..83497ede --- /dev/null +++ b/.github/workflows/recheck.yaml @@ -0,0 +1,20 @@ +# Workflow derived from https://github.com/r-devel/recheck +on: + workflow_dispatch: + inputs: + which: + type: choice + description: Which dependents to check + options: + - strong + - most + +name: r-devel reverse dependency check + +jobs: + revdep_check: + name: Reverse check ${{ inputs.which }} dependents + uses: r-devel/recheck/.github/workflows/recheck.yml@v1 + with: + which: ${{ inputs.which }} + diff --git a/CITATION.cff b/CITATION.cff index df7f23e0..0db56e06 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -8,7 +8,7 @@ message: 'To cite package "nominatimlite" in publications use:' type: software license: MIT title: 'nominatimlite: Interface with ''Nominatim'' API Service' -version: 0.4.0.9000 +version: 0.4.1 doi: 10.32614/CRAN.package.nominatimlite abstract: Lite interface for getting data from 'OSM' service 'Nominatim' . Extract coordinates from addresses, find places near a set of coordinates and return @@ -28,7 +28,7 @@ preferred-citation: orcid: https://orcid.org/0000-0001-8457-4658 doi: 10.32614/CRAN.package.nominatimlite year: '2024' - version: 0.4.0.9000 + version: 0.4.1 url: https://dieghernan.github.io/nominatimlite/ abstract: Lite interface for getting data from OSM service Nominatim . Extract coordinates from addresses, find places near a set of coordinates and @@ -105,9 +105,6 @@ references: email: jeroen@berkeley.edu orcid: https://orcid.org/0000-0002-4035-0289 year: '2024' - identifiers: - - type: url - value: https://arxiv.org/abs/1403.2805 version: '>= 1.7.0' - type: software title: sf diff --git a/DESCRIPTION b/DESCRIPTION index 2041a5d5..453e200c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: nominatimlite Title: Interface with 'Nominatim' API Service -Version: 0.4.0.9000 +Version: 0.4.1 Authors@R: c( person("Diego", "Hernangómez", , "diego.hernangomezherrero@gmail.com", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0001-8457-4658")), diff --git a/NEWS.md b/NEWS.md index c5a50516..f6c03e55 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# nominatimlite (development version) +# nominatimlite 0.4.1 - Fix input validation in `geo_address_lookup()` and `geo_address_lookup_sf()` that crashes the function if the OSM ID is too long (#47 reported by diff --git a/R/geo_address_lookup.R b/R/geo_address_lookup.R index 11a5156f..aeecdea9 100644 --- a/R/geo_address_lookup.R +++ b/R/geo_address_lookup.R @@ -1,4 +1,4 @@ -#' Address lookup API for OSM elements +#' Address lookup API #' #' @description #' The lookup API allows to query the address and other details of one or diff --git a/R/geo_address_lookup_sf.R b/R/geo_address_lookup_sf.R index 5ca19701..ade0fcea 100644 --- a/R/geo_address_lookup_sf.R +++ b/R/geo_address_lookup_sf.R @@ -1,4 +1,4 @@ -#' Address lookup API for OSM elements in \CRANpkg{sf} format +#' Address lookup API in \CRANpkg{sf} format #' #' @description #' The lookup API allows to query the address and other details of one or diff --git a/R/geo_lite.R b/R/geo_lite.R index 4e8f6634..898781df 100644 --- a/R/geo_lite.R +++ b/R/geo_lite.R @@ -1,4 +1,4 @@ -#' Address search API for OSM elements (free-form query) +#' Address search API (free-form query) #' #' @description #' Geocodes addresses given as character values. This function returns the diff --git a/R/geo_lite_sf.R b/R/geo_lite_sf.R index ea80586e..a820a540 100644 --- a/R/geo_lite_sf.R +++ b/R/geo_lite_sf.R @@ -1,4 +1,4 @@ -#' Address search API for OSM elements in \CRANpkg{sf} format (free-form query) +#' Address search API in \CRANpkg{sf} format (free-form query) #' #' @description #' This function allows you to geocode addresses and returns the corresponding diff --git a/R/geo_lite_struct.R b/R/geo_lite_struct.R index 8d8b4772..3b10179c 100644 --- a/R/geo_lite_struct.R +++ b/R/geo_lite_struct.R @@ -1,4 +1,4 @@ -#' Address search API for OSM elements (structured query) +#' Address search API (structured query) #' #' @description #' Geocodes addresses already split into components. This function returns the diff --git a/R/geo_lite_struct_sf.R b/R/geo_lite_struct_sf.R index ca6cacc5..473e3f9b 100644 --- a/R/geo_lite_struct_sf.R +++ b/R/geo_lite_struct_sf.R @@ -1,4 +1,4 @@ -#' Address search API for OSM elements in \CRANpkg{sf} format (structured query) +#' Address search API in \CRANpkg{sf} format (structured query) #' #' @description #' Geocodes addresses already split into components and return the corresponding diff --git a/R/reverse_geo_lite.R b/R/reverse_geo_lite.R index c5a89e2d..beb2c982 100644 --- a/R/reverse_geo_lite.R +++ b/R/reverse_geo_lite.R @@ -1,4 +1,4 @@ -#' Reverse geocoding API for OSM elements +#' Reverse geocoding API #' #' @description #' diff --git a/R/reverse_geo_lite_sf.R b/R/reverse_geo_lite_sf.R index bd5b85bc..afb8bb08 100644 --- a/R/reverse_geo_lite_sf.R +++ b/R/reverse_geo_lite_sf.R @@ -1,4 +1,4 @@ -#' Reverse geocoding API for OSM elements in \CRANpkg{sf} format +#' Reverse geocoding API in \CRANpkg{sf} format #' #' @description #' diff --git a/README.Rmd b/README.Rmd index bd5a1ab1..08d2a987 100644 --- a/README.Rmd +++ b/README.Rmd @@ -33,7 +33,6 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r [![R-CMD-check](https://github.com/dieghernan/nominatimlite/actions/workflows/check-full.yaml/badge.svg)](https://github.com/dieghernan/nominatimlite/actions/workflows/check-full.yaml) [![R-hub](https://github.com/dieghernan/nominatimlite/actions/workflows/rhub.yaml/badge.svg)](https://github.com/dieghernan/nominatimlite/actions/workflows/rhub.yaml) [![codecov](https://codecov.io/gh/dieghernan/nominatimlite/branch/main/graph/badge.svg?token=jSZ4RIsj91)](https://app.codecov.io/gh/dieghernan/nominatimlite) -[![r-universe](https://dieghernan.r-universe.dev/badges/nominatimlite)](https://dieghernan.r-universe.dev/nominatimlite) [![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite) [![Project Status: Active -- The project has reached a stable, usable state and is being actively @@ -95,8 +94,7 @@ You can install the developing version of **nominatimlite** with: remotes::install_github("dieghernan/nominatimlite") ``` -Alternatively, you can install **nominatimlite** using the -[r-universe](https://dieghernan.r-universe.dev/nominatimlite): +Alternatively, you can install **nominatimlite** using the **r-universe**: ```{r, eval=FALSE} # Install nominatimlite in R: @@ -114,7 +112,7 @@ install.packages("nominatimlite", With **nominatimlite** you can extract spatial objects easily: -```{r pizzahut} +```{r pizzahut, fig.alt="Locations of Pizza Hut restaurants in California extracted with nominatimlite"} library(nominatimlite) # Extract some points - Pizza Hut in California @@ -136,14 +134,14 @@ ggplot(CA) + You can also extract polygon and line objects (as provided by the Nominatim API) using the option `points_only = FALSE`: -```{r statue_liberty } +```{r statue_liberty, fig.alt="Location of Statue of Liberty extracted with nominatimlite"} sol_poly <- geo_lite_sf("Statue of Liberty, NY, USA", points_only = FALSE) # a building - a polygon ggplot(sol_poly) + geom_sf() ``` -```{r line-object} +```{r line-object, fig.alt="Different features named Ohio extracted with nominatimlite"} dayton <- geo_lite_sf("Dayton, OH") # default - a point ohio_state <- geo_lite_sf("Ohio, USA", points_only = FALSE) # a US state - a polygon ohio_river <- geo_lite_sf("Ohio river", points_only = FALSE) # a river - a line diff --git a/README.md b/README.md index ed9f546e..461c9a9d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r [![R-CMD-check](https://github.com/dieghernan/nominatimlite/actions/workflows/check-full.yaml/badge.svg)](https://github.com/dieghernan/nominatimlite/actions/workflows/check-full.yaml) [![R-hub](https://github.com/dieghernan/nominatimlite/actions/workflows/rhub.yaml/badge.svg)](https://github.com/dieghernan/nominatimlite/actions/workflows/rhub.yaml) [![codecov](https://codecov.io/gh/dieghernan/nominatimlite/branch/main/graph/badge.svg?token=jSZ4RIsj91)](https://app.codecov.io/gh/dieghernan/nominatimlite) -[![r-universe](https://dieghernan.r-universe.dev/badges/nominatimlite)](https://dieghernan.r-universe.dev/nominatimlite) [![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite) [![Project Status: Active – The project has reached a stable, usable state and is being actively @@ -79,7 +78,7 @@ remotes::install_github("dieghernan/nominatimlite") ``` Alternatively, you can install **nominatimlite** using the -[r-universe](https://dieghernan.r-universe.dev/nominatimlite): +**r-universe**: ``` r # Install nominatimlite in R: @@ -116,7 +115,7 @@ ggplot(CA) + geom_sf(data = pizzahut, col = "red") ``` - +Locations of Pizza Hut restaurants in California extracted with nominatimlite You can also extract polygon and line objects (as provided by the Nominatim API) using the option `points_only = FALSE`: @@ -128,7 +127,7 @@ ggplot(sol_poly) + geom_sf() ``` - +Location of Statue of Liberty extracted with nominatimlite ``` r dayton <- geo_lite_sf("Dayton, OH") # default - a point @@ -141,7 +140,7 @@ ggplot() + geom_sf(data = ohio_river, color = "blue") ``` - +Different features named Ohio extracted with nominatimlite ### Geocoding and reverse geocoding @@ -217,7 +216,7 @@ A BibTeX entry for LaTeX users is doi = {10.32614/CRAN.package.nominatimlite}, author = {Diego Hernangómez}, year = {2024}, - version = {0.4.0.9000}, + version = {0.4.1}, url = {https://dieghernan.github.io/nominatimlite/}, abstract = {Lite interface for getting data from OSM service Nominatim . Extract coordinates from addresses, find places near a set of coordinates and return spatial objects on sf format.}, } diff --git a/codemeta.json b/codemeta.json index 9495e971..2dfa3706 100644 --- a/codemeta.json +++ b/codemeta.json @@ -8,7 +8,7 @@ "codeRepository": "https://github.com/dieghernan/nominatimlite", "issueTracker": "https://github.com/dieghernan/nominatimlite/issues", "license": "https://spdx.org/licenses/MIT", - "version": "0.4.0.9000", + "version": "0.4.1", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", @@ -220,7 +220,7 @@ }, "applicationCategory": "cartography", "keywords": ["r", "geocoding", "openstreetmap", "address", "nominatim", "reverse-geocoding", "rstats", "shapefile", "r-package", "spatial", "cran", "api-wrapper", "api", "gis"], - "fileSize": "252.444KB", + "fileSize": "250.421KB", "citation": [ { "@type": "SoftwareSourceCode", diff --git a/inst/schemaorg.json b/inst/schemaorg.json index 84fee47b..63db1bfd 100644 --- a/inst/schemaorg.json +++ b/inst/schemaorg.json @@ -48,7 +48,7 @@ "url": "https://cran.r-project.org" }, "runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)", - "version": "0.4.0.9000" + "version": "0.4.1" }, { "id": "https://doi.org/10.32614/CRAN.package.nominatimlite", diff --git a/man/figures/README-line-object-1.png b/man/figures/README-line-object-1.png index 846188aa..ed895fe6 100644 Binary files a/man/figures/README-line-object-1.png and b/man/figures/README-line-object-1.png differ diff --git a/man/figures/README-pizzahut-1.png b/man/figures/README-pizzahut-1.png index e9ef54f2..ab3cab24 100644 Binary files a/man/figures/README-pizzahut-1.png and b/man/figures/README-pizzahut-1.png differ diff --git a/man/geo_address_lookup.Rd b/man/geo_address_lookup.Rd index e2e6aa25..22742608 100644 --- a/man/geo_address_lookup.Rd +++ b/man/geo_address_lookup.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_address_lookup.R \name{geo_address_lookup} \alias{geo_address_lookup} -\title{Address lookup API for OSM elements} +\title{Address lookup API} \usage{ geo_address_lookup( osm_ids, diff --git a/man/geo_address_lookup_sf.Rd b/man/geo_address_lookup_sf.Rd index 67f6cc9f..d1463a03 100644 --- a/man/geo_address_lookup_sf.Rd +++ b/man/geo_address_lookup_sf.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_address_lookup_sf.R \name{geo_address_lookup_sf} \alias{geo_address_lookup_sf} -\title{Address lookup API for OSM elements in \CRANpkg{sf} format} +\title{Address lookup API in \CRANpkg{sf} format} \usage{ geo_address_lookup_sf( osm_ids, diff --git a/man/geo_lite.Rd b/man/geo_lite.Rd index 0c2f452b..47d39426 100644 --- a/man/geo_lite.Rd +++ b/man/geo_lite.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_lite.R \name{geo_lite} \alias{geo_lite} -\title{Address search API for OSM elements (free-form query)} +\title{Address search API (free-form query)} \usage{ geo_lite( address, diff --git a/man/geo_lite_sf.Rd b/man/geo_lite_sf.Rd index 432f8b43..158a7816 100644 --- a/man/geo_lite_sf.Rd +++ b/man/geo_lite_sf.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_lite_sf.R \name{geo_lite_sf} \alias{geo_lite_sf} -\title{Address search API for OSM elements in \CRANpkg{sf} format (free-form query)} +\title{Address search API in \CRANpkg{sf} format (free-form query)} \usage{ geo_lite_sf( address, diff --git a/man/geo_lite_struct.Rd b/man/geo_lite_struct.Rd index e10154d7..ef9d2064 100644 --- a/man/geo_lite_struct.Rd +++ b/man/geo_lite_struct.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_lite_struct.R \name{geo_lite_struct} \alias{geo_lite_struct} -\title{Address search API for OSM elements (structured query)} +\title{Address search API (structured query)} \usage{ geo_lite_struct( amenity = NULL, diff --git a/man/geo_lite_struct_sf.Rd b/man/geo_lite_struct_sf.Rd index 00423a11..883c633a 100644 --- a/man/geo_lite_struct_sf.Rd +++ b/man/geo_lite_struct_sf.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo_lite_struct_sf.R \name{geo_lite_struct_sf} \alias{geo_lite_struct_sf} -\title{Address search API for OSM elements in \CRANpkg{sf} format (structured query)} +\title{Address search API in \CRANpkg{sf} format (structured query)} \usage{ geo_lite_struct_sf( amenity = NULL, diff --git a/man/reverse_geo_lite.Rd b/man/reverse_geo_lite.Rd index 90c8af42..452edb62 100644 --- a/man/reverse_geo_lite.Rd +++ b/man/reverse_geo_lite.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/reverse_geo_lite.R \name{reverse_geo_lite} \alias{reverse_geo_lite} -\title{Reverse geocoding API for OSM elements} +\title{Reverse geocoding API} \usage{ reverse_geo_lite( lat, diff --git a/man/reverse_geo_lite_sf.Rd b/man/reverse_geo_lite_sf.Rd index a4cf8b4a..a960ece6 100644 --- a/man/reverse_geo_lite_sf.Rd +++ b/man/reverse_geo_lite_sf.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/reverse_geo_lite_sf.R \name{reverse_geo_lite_sf} \alias{reverse_geo_lite_sf} -\title{Reverse geocoding API for OSM elements in \CRANpkg{sf} format} +\title{Reverse geocoding API in \CRANpkg{sf} format} \usage{ reverse_geo_lite_sf( lat, diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png index 49200dac..2bd4b2ce 100644 Binary files a/pkgdown/favicon/apple-touch-icon-120x120.png and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png index 5138a902..d7bc79ce 100644 Binary files a/pkgdown/favicon/apple-touch-icon-152x152.png and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png index f5e7494b..0a4b872b 100644 Binary files a/pkgdown/favicon/apple-touch-icon-180x180.png and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png index 9a8e8a56..87d165f3 100644 Binary files a/pkgdown/favicon/apple-touch-icon-60x60.png and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png index 83a08503..ff97cffa 100644 Binary files a/pkgdown/favicon/apple-touch-icon-76x76.png and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png index f5e7494b..0a4b872b 100644 Binary files a/pkgdown/favicon/apple-touch-icon.png and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png index c1d2944e..e6431f0b 100644 Binary files a/pkgdown/favicon/favicon-16x16.png and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png index fe72279b..f2398558 100644 Binary files a/pkgdown/favicon/favicon-32x32.png and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico index 269e5707..d3ca8373 100644 Binary files a/pkgdown/favicon/favicon.ico and b/pkgdown/favicon/favicon.ico differ diff --git a/vignettes/nominatimlite.Rmd b/vignettes/nominatimlite.Rmd index f02e69df..2c9973f1 100644 --- a/vignettes/nominatimlite.Rmd +++ b/vignettes/nominatimlite.Rmd @@ -78,7 +78,7 @@ ggplot(CA) + geom_sf(data = pizzahut, col = "red") ``` -![Pizza Hut in California](../man/figures/README-pizzahut-1.png){width="100%"} +![Locations of Pizza Hut in California](../man/figures/README-pizzahut-1.png){width="100%"} You can also extract polygon and line objects (if available) using the option `points_only = FALSE`: diff --git a/vignettes/nominatimlite.Rmd.orig b/vignettes/nominatimlite.Rmd.orig index 764a4815..4b0cdf36 100644 --- a/vignettes/nominatimlite.Rmd.orig +++ b/vignettes/nominatimlite.Rmd.orig @@ -88,7 +88,7 @@ ggplot(CA) + geom_sf(data = pizzahut, col = "red") ``` -![Pizza Hut in California](../man/figures/README-pizzahut-1.png){width="100%"} +![Locations of Pizza Hut in California](../man/figures/README-pizzahut-1.png){width="100%"} You can also extract polygon and line objects (if available) using the option `points_only = FALSE`: