Add progress bars and deprecate amenities (#38)

* Add progress bars

* Update tests

* Deprecate geo amenities

* Update wordlist

* Update docs with pkgdev

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/workflows/wipe-cache.yaml

@@ -1,6 +1,8 @@
 name: Clear all Github actions caches manually
 on:
   workflow_dispatch:
+  schedule:
+    - cron: '0 16 15 * *'
 
 jobs:
   cache-clear:

CITATION.cff

@@ -8,11 +8,11 @@ message: 'To cite package "nominatimlite" in publications use:'
 type: software
 license: MIT
 title: 'nominatimlite: Interface with ''Nominatim'' API Service'
-version: 0.2.1
+version: 0.2.1.9000
 doi: 10.5281/zenodo.5113195
 abstract: Lite interface for getting data from 'OSM' service 'Nominatim' <https://nominatim.org/release-docs/latest/>.
-  Extract coordinates from addresses, find places near a set of coordinates, search
-  for amenities and return spatial objects on 'sf' format.
+  Extract coordinates from addresses, find places near a set of coordinates and return
+  spatial objects on 'sf' format.
 authors:
 - family-names: Hernangómez
   given-names: Diego
@@ -26,13 +26,13 @@ preferred-citation:
     given-names: Diego
     email: [email protected]
     orcid: https://orcid.org/0000-0001-8457-4658
-  year: '2023'
-  version: 0.2.1
+  year: '2024'
+  version: 0.2.1.9000
   doi: 10.5281/zenodo.5113195
   url: https://dieghernan.github.io/nominatimlite/
   abstract: Lite interface for getting data from OSM service Nominatim <https://nominatim.org/release-docs/latest/>.
-    Extract coordinates from addresses, find places near a set of coordinates, search
-    for amenities and return spatial objects on sf format.
+    Extract coordinates from addresses, find places near a set of coordinates and
+    return spatial objects on sf format.
 repository: https://CRAN.R-project.org/package=nominatimlite
 repository-code: https://github.com/dieghernan/nominatimlite
 url: https://dieghernan.github.io/nominatimlite/
@@ -65,7 +65,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
   version: '>= 3.6.0'
@@ -92,7 +92,7 @@ references:
     given-names: Davis
     email: [email protected]
     orcid: https://orcid.org/0000-0003-4777-038X
-  year: '2023'
+  year: '2024'
   version: '>= 1.0.0'
 - type: software
   title: jsonlite
@@ -105,11 +105,26 @@ references:
     given-names: Jeroen
     email: [email protected]
     orcid: https://orcid.org/0000-0002-4035-0289
-  year: '2023'
+  year: '2024'
   identifiers:
   - type: url
     value: https://arxiv.org/abs/1403.2805
   version: '>= 1.7.0'
+- type: software
+  title: lifecycle
+  abstract: 'lifecycle: Manage the Life Cycle of your Package Functions'
+  notes: Imports
+  url: https://lifecycle.r-lib.org/
+  repository: https://CRAN.R-project.org/package=lifecycle
+  authors:
+  - family-names: Henry
+    given-names: Lionel
+    email: [email protected]
+  - family-names: Wickham
+    given-names: Hadley
+    email: [email protected]
+    orcid: https://orcid.org/0000-0003-4757-117X
+  year: '2024'
 - type: software
   title: sf
   abstract: 'sf: Simple Features for R'
@@ -121,7 +136,7 @@ references:
     given-names: Edzer
     email: [email protected]
     orcid: https://orcid.org/0000-0001-8049-7069
-  year: '2023'
+  year: '2024'
   version: '>= 0.9.0'
 - type: software
   title: utils
@@ -131,7 +146,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
 - type: software
@@ -168,7 +183,7 @@ references:
   - family-names: Dunnington
     given-names: Dewey
     orcid: https://orcid.org/0000-0002-9415-4582
-  year: '2023'
+  year: '2024'
   version: '>= 3.0.0'
 - type: software
   title: knitr
@@ -181,7 +196,7 @@ references:
     given-names: Yihui
     email: [email protected]
     orcid: https://orcid.org/0000-0003-0645-5666
-  year: '2023'
+  year: '2024'
 - type: software
   title: rmarkdown
   abstract: 'rmarkdown: Dynamic Documents for R'
@@ -224,7 +239,7 @@ references:
     given-names: Richard
     email: [email protected]
     orcid: https://orcid.org/0000-0003-3925-190X
-  year: '2023'
+  year: '2024'
 - type: software
   title: testthat
   abstract: 'testthat: Unit Testing for R'
@@ -235,7 +250,7 @@ references:
   - family-names: Wickham
     given-names: Hadley
     email: [email protected]
-  year: '2023'
+  year: '2024'
   version: '>= 3.0.0'
 - type: software
   title: tidygeocoder
@@ -260,4 +275,4 @@ references:
     given-names: Daniel
     email: [email protected]
     orcid: https://orcid.org/0000-0002-6738-9845
-  year: '2023'
+  year: '2024'

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: nominatimlite
 Title: Interface with 'Nominatim' API Service
-Version: 0.2.1
+Version: 0.2.1.9000
 Authors@R: c(
     person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8457-4658")),
@@ -10,8 +10,8 @@ Authors@R: c(
   )
 Description: Lite interface for getting data from 'OSM' service
     'Nominatim' <https://nominatim.org/release-docs/latest/>. Extract
-    coordinates from addresses, find places near a set of coordinates,
-    search for amenities and return spatial objects on 'sf' format.
+    coordinates from addresses, find places near a set of coordinates and
+    return spatial objects on 'sf' format.
 License: MIT + file LICENSE
 URL: https://dieghernan.github.io/nominatimlite/,
     https://github.com/dieghernan/nominatimlite
@@ -21,6 +21,7 @@ Depends:
 Imports: 
     dplyr (>= 1.0.0),
     jsonlite (>= 1.7.0),
+    lifecycle,
     sf (>= 0.9.0),
     utils
 Suggests: 
@@ -37,7 +38,6 @@ Config/testthat/parallel: true
 Copyright: Data © OpenStreetMap contributors, ODbL 1.0.
     <https://www.openstreetmap.org/copyright>
 Encoding: UTF-8
-LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
 X-schema.org-applicationCategory: cartography

NAMESPACE

@@ -11,3 +11,5 @@ export(nominatim_check_access)
 export(reverse_geo_lite)
 export(reverse_geo_lite_sf)
 importFrom(utils,download.file)
+importFrom(utils,setTxtProgressBar)
+importFrom(utils,txtProgressBar)

NEWS.md

@@ -1,3 +1,15 @@
+# nominatimlite (development version)
+
+-   Add a `progressbar` parameter to `geo_lite()`, `geo_lite_sf()`,
+    `reverse_geo_lite()` and `reverse_geo_lite_sf()` to display progress in the
+    console.
+
+## Deprecated
+
+-   `geo_amenity()` and `geo_amenity_sf()`, see
+    [Nominatim/issues/1311](https://github.com/osm-search/Nominatim/issues/1311).
+-   `nominatimlite::osm_amenities` data set deleted.
+
 # nominatimlite 0.2.1
 
 -   Remove **osmdata** from Suggests.

R/bbox_to_poly.R

@@ -1,4 +1,4 @@
-#' Create a bounding box `sf` object
+#' Create a bounding box \CRANpkg{sf} object
 #'
 #' @description
 #'
@@ -16,7 +16,6 @@
 #' @seealso [sf::st_as_sfc()]
 #'
 #' @family spatial
-#' @family amenity
 #'
 #' @details
 #'

R/geo_address_lookup.R

@@ -21,7 +21,7 @@
 #' @family lookup
 #' @family geocoding
 #'
-#' @return A `tibble` with the results found by the query.
+#' @return A \CRANpkg{tibble} with the results found by the query.
 #'
 #' @examplesIf nominatim_check_access()
 #' \donttest{

R/geo_address_lookup_sf.R

@@ -6,7 +6,7 @@
 #' \CRANpkg{sf} spatial object associated with the query, see
 #' [geo_address_lookup()] for retrieving the data in \CRANpkg{tibble} format.
 #'
-#' @return A `sf` object with the results.
+#' @return A \CRANpkg{sf} object with the results.
 #'
 #' @inheritParams geo_lite_sf
 #' @inheritParams geo_address_lookup