Prepare for CRAN

dieghernan · May 27, 2024 · 071179a · 071179a
1 parent d5fe44e
commit 071179a
Show file tree

Hide file tree

Showing 15 changed files with 82 additions and 82 deletions.
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -1,4 +1,4 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
  push:
@@ -10,9 +10,10 @@ name: test-coverage
 
 jobs:
  test-coverage:
- runs-on: macos-latest
+ runs-on: ubuntu-latest
  env:
  GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+ CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
  steps:
  - uses: actions/checkout@v4
@@ -28,18 +29,20 @@ jobs:
 
  - name: Test coverage
  run: |
+ token <- Sys.getenv("CODECOV_TOKEN", "")
  covr::codecov(
  quiet = FALSE,
  clean = FALSE,
- install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+ install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package"),
+ token = if (token != "") token
  )
  shell: Rscript {0}
 
  - name: Show testthat output
  if: always()
  run: |
  ## --------------------------------------------------------------------
- find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
+ find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
  shell: bash
 
  - name: Upload test results

diff --git 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.3.0.9000
+version: 0.4.0
 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 and return
@@ -27,7 +27,7 @@ preferred-citation:
  email: [email protected]
  orcid: https://orcid.org/0000-0001-8457-4658
  year: '2024'
- version: 0.3.0.9000
+ version: 0.4.0
  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/>.
@@ -105,9 +105,6 @@ references:
  email: [email protected]
  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
@@ -1,7 +1,7 @@
 Type: Package
 Package: nominatimlite
 Title: Interface with 'Nominatim' API Service
-Version: 0.3.0.9000
+Version: 0.4.0
 Authors@R: c(
  person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
  comment = c(ORCID = "0000-0001-8457-4658")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# nominatimlite (development version)
+# nominatimlite 0.4.0
 
 - New functions:
 
@@ -89,7 +89,7 @@
 # nominatimlite 0.1.2
 
 - New internal: `nominatim_check_access()`.
-- Adapt tests to **testthat** v3.1.0.
+- Adapt tests to **testthat** `v3.1.0`.
 
 # nominatimlite 0.1.1
 
@@ -100,7 +100,7 @@
 - **CRAN** release.
 - Adjust query rate limits to Nominatim policy.
 - New `strict` argument on `geo_amenity()` and `geo_amenity_sf()`.
-- Parameter `polygon` changed to `points_only` #8 thanks to @jlacko.
+- Parameter `polygon` changed to `points_only` (#8) thanks to @jlacko.
 - Package now falls gracefully if url not reachable.
 
 # nominatimlite 0.0.1

diff --git a/README.Rmd b/README.Rmd
@@ -39,7 +39,7 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r
 is being actively
 developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.5113195-blue)](https://doi.org/10.5281/zenodo.5113195)
-[![status](https://tinyverse.netlify.com/badge/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)
+[![status](https://tinyverse.netlify.app/status/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)
 
 <!-- badges: end -->
 

diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r
 state and is being actively
 developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.5113195-blue)](https://doi.org/10.5281/zenodo.5113195)
-[![status](https://tinyverse.netlify.com/badge/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)
+[![status](https://tinyverse.netlify.app/status/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)
 
 <!-- badges: end -->
 
@@ -191,11 +191,11 @@ reverse <- reverse_geo_lite(
 #> | | | 0% | |================= | 33% | |================================= | 67% | |==================================================| 100%
 ```
 
-| address_found  | lat | lon |
-|:------------------------------------------------------------------------------------------------------------------------------------------|---------:|-----------:|
-| Zastava Sjedinjenih Američkih Država, 1600, Pennsylvania Avenue Northwest, Ward 2, Washington, District of Columbia, 20500, United States | 38.89772 | -77.03655 |
-| Transamerica Pyramid, 600, Montgomery Street, Financial District, San Francisco, California, 94111, United States  | 37.79520 | -122.40279 |
-| West Adams Street, Printer’s Row, Loop, Chicago, Cook County, Illinois, 60606, United States  | 41.87874 | -87.63589 |
+| address_found | lat | lon |
+|:------------------------------------------------------------------------------------------------------------------------------------|---------:|-----------:|
+| Zastava Sjedinjenih Američkih Država, Pennsylvania Avenue Northwest, Ward 2, Washington, District of Columbia, 20006, United States | 38.89772 | -77.03655 |
+| Transamerica Pyramid, 600, Montgomery Street, Financial District, San Francisco, California, 94111, United States | 37.79520 | -122.40279 |
+| Willis Tower, 233, South Wacker Drive, Printer’s Row, Loop, Chicago, Cook County, Illinois, 60606, United States | 41.87874 | -87.63596 |
 
 For more advance users, see [Nominatim
 docs](https://nominatim.org/release-docs/latest/api/Search/) to check
@@ -216,7 +216,7 @@ A BibTeX entry for LaTeX users is
   title = {{nominatimlite}: Interface with {Nominatim} {API} Service},
   author = {Diego Hernangómez},
   year = {2024},
-  version = {0.3.0.9000},
+  version = {0.4.0},
   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 and return spatial objects on sf format.},

diff --git a/codecov.yml b/codecov.yml
diff --git a/codemeta.json b/codemeta.json
@@ -8,13 +8,13 @@
  "codeRepository": "https://github.com/dieghernan/nominatimlite",
  "issueTracker": "https://github.com/dieghernan/nominatimlite/issues",
  "license": "https://spdx.org/licenses/MIT",
- "version": "0.3.0.9000",
+ "version": "0.4.0",
  "programmingLanguage": {
  "@type": "ComputerLanguage",
  "name": "R",
  "url": "https://r-project.org"
  },
- "runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
+ "runtimePlatform": "R version 4.4.0 (2024-04-24 ucrt)",
  "provider": {
  "@id": "https://cran.r-project.org",
  "@type": "Organization",
@@ -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.05KB",
+ "fileSize": "250.723KB",
  "citation": [
  {
  "@type": "SoftwareSourceCode",

diff --git a/data/osm_amenities.rda b/data/osm_amenities.rda
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -1,9 +1,11 @@
+Američkih
 ArcGIS
 Belanger
 CMD
 Cambon
 CodeFactor
 DOI
+Država
 Flaticon
 Freepik
 Geocode
@@ -18,8 +20,10 @@ OSM
 Padgham
 Possenriede
 Rudis
+Sjedinjenih
 TomTom
 Transamerica
+Zastava
 al
 api
 arcgeocoder
@@ -28,7 +32,6 @@ codecov
 crosstalk
 de
 et
-geo
 geocode
 geocoded
 geocoder
@@ -37,7 +40,6 @@ geolocated
 ie
 json
 lon
-osm
 osmdata
 reactable
 rlang

diff --git a/inst/schemaorg.json b/inst/schemaorg.json
@@ -47,8 +47,8 @@
  "name": "Comprehensive R Archive Network (CRAN)",
  "url": "https://cran.r-project.org"
  },
- "runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
- "version": "0.3.0.9000"
+ "runtimePlatform": "R version 4.4.0 (2024-04-24 ucrt)",
+ "version": "0.4.0"
  },
  {
  "id": "https://doi.org/10.5281/zenodo.5113195",

diff --git a/man/figures/README-pizzahut-1.png b/man/figures/README-pizzahut-1.png
diff --git a/revdep/README.md b/revdep/README.md
@@ -1,49 +1,50 @@
 # Platform
 
-|field |value |
-|:--------|:--------------------------------------------------------------------------|
-|version |R version 4.3.3 (2024-02-29 ucrt) |
-|os |Windows Server 2022 x64 (build 20348) |
-|system |x86_64, mingw32 |
-|ui |RTerm |
-|language |(EN) |
-|collate |English_United States.utf8 |
-|ctype |English_United States.utf8 |
-|tz |UTC |
-|date |2024-04-08 |
-|pandoc |3.1.11 @ C:\HOSTED~1\windows\pandoc\31F387~1.11\x64\PANDOC~1.11\pandoc.exe |
+|field |value |
+|:--------|:----------------------------------------|
+|version |R version 4.4.0 (2024-04-24 ucrt) |
+|os |Windows 11 x64 (build 22631) |
+|system |x86_64, mingw32 |
+|ui |RStudio |
+|language |(EN) |
+|collate |Spanish_Spain.utf8 |
+|ctype |Spanish_Spain.utf8 |
+|tz |Europe/Madrid |
+|date |2024-05-27 |
+|rstudio |2024.04.1+748 Chocolate Cosmos (desktop) |
+|pandoc |3.1.12.2 @ C:\PROGRA~1\Pandoc\pandoc.exe |
 
 # Dependencies
 
-|package |old |new  |Δ |
-|:-------------|:------|:----------|:--|
-|nominatimlite |0.3.0 |0.3.0.9000 |* |
-|classInt |0.4-10 |0.4-10  | |
-|cli |3.6.2 |3.6.2  | |
-|DBI |1.2.2 |1.2.2  | |
-|dplyr |1.1.4 |1.1.4  | |
-|e1071 |1.7-14 |1.7-14  | |
-|fansi |1.0.6 |1.0.6  | |
-|generics |0.1.3 |0.1.3  | |
-|glue |1.7.0 |1.7.0  | |
-|jsonlite |1.8.8 |1.8.8  | |
-|lifecycle |1.0.4 |1.0.4  | |
-|magrittr |2.0.3 |2.0.3  | |
-|pillar |1.9.0 |1.9.0  | |
-|pkgconfig |2.0.3 |2.0.3  | |
-|proxy |0.4-27 |0.4-27  | |
-|R6 |2.5.1 |2.5.1  | |
-|Rcpp |1.0.12 |1.0.12  | |
-|rlang |1.1.3 |1.1.3  | |
-|s2 |1.1.6 |1.1.6  | |
-|sf |1.0-16 |1.0-16  | |
-|tibble |3.2.1 |3.2.1  | |
-|tidyselect |1.2.1 |1.2.1  | |
-|units |0.8-5 |0.8-5  | |
-|utf8 |1.2.4 |1.2.4  | |
-|vctrs |0.6.5 |0.6.5  | |
-|withr |3.0.0 |3.0.0  | |
-|wk |0.9.1 |0.9.1  | |
+|package |old |new |Δ |
+|:-------------|:------|:------|:--|
+|nominatimlite |0.3.0 |0.4.0  |* |
+|classInt |0.4-10 |0.4-10 | |
+|cli |3.6.2 |3.6.2 | |
+|DBI |1.2.2 |1.2.2 | |
+|dplyr |1.1.4 |1.1.4 | |
+|e1071 |1.7-14 |1.7-14 | |
+|fansi |1.0.6 |1.0.6 | |
+|generics |0.1.3 |0.1.3 | |
+|glue |1.7.0 |1.7.0 | |
+|jsonlite |1.8.8 |1.8.8 | |
+|lifecycle |1.0.4 |1.0.4 | |
+|magrittr |2.0.3 |2.0.3 | |
+|pillar |1.9.0 |1.9.0 | |
+|pkgconfig |2.0.3 |2.0.3 | |
+|proxy |0.4-27 |0.4-27 | |
+|R6 |2.5.1 |2.5.1 | |
+|Rcpp |1.0.12 |1.0.12 | |
+|rlang |1.1.3 |1.1.3 | |
+|s2 |1.1.6 |1.1.6 | |
+|sf |1.0-16 |1.0-16 | |
+|tibble |3.2.1 |3.2.1 | |
+|tidyselect |1.2.1 |1.2.1 | |
+|units |0.8-5 |0.8-5 | |
+|utf8 |1.2.4 |1.2.4 | |
+|vctrs |0.6.5 |0.6.5 | |
+|withr |3.0.0 |3.0.0 | |
+|wk |0.9.1 |0.9.1 | |
 
 # Revdeps
 
diff --git a/revdep/cran.md b/revdep/cran.md
@@ -1,6 +1,6 @@
 ## revdepcheck results
 
-We checked 1 reverse dependencies (0 from CRAN + 1 from Bioconductor), comparing R CMD check results across CRAN and dev versions of this package.
+We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
 
  * We saw 0 new problems
  * We failed to check 0 packages

diff --git a/vignettes/nominatimlite.Rmd b/vignettes/nominatimlite.Rmd
@@ -59,7 +59,7 @@ that presents similar features:
 With **nominatimlite** you can extract spatial objects easily:
 
 
-```r
+``` r
 library(nominatimlite)
 
 # Extract some points - Pizza Hut in California
@@ -84,7 +84,7 @@ You can also extract polygon and line objects (if available) using the option
 `points_only = FALSE`:
 
 
-```r
+``` r
 sol_poly <- geo_lite_sf("Statue of Liberty, NY, USA", points_only = FALSE)
 
 ggplot(sol_poly) +
@@ -102,7 +102,7 @@ In this first example we will geocode a few addresses using the `geo_lite()`
 function:
 
 
-```r
+``` r
 library(tibble)
 
 # create a dataframe with addresses
@@ -139,7 +139,7 @@ and `long` arguments. The dataset used here is from the geocoder query above.
 The single line address is returned in a column named by the `address`.
 
 
-```r
+``` r
 reverse <- reverse_geo_lite(
  lat = lat_longs$latitude, long = lat_longs$longitude,
  address = "address_found"
@@ -149,11 +149,11 @@ reverse <- reverse_geo_lite(
 
 
 
-|address_found  | lat| lon|
-|:-----------------------------------------------------------------------------------------------------------------------------------------|--------:|----------:|
-|Zastava Sjedinjenih Američkih Država, 1600, Pennsylvania Avenue Northwest, Ward 2, Washington, District of Columbia, 20500, United States | 38.89772| -77.03655|
-|Transamerica Pyramid, 600, Montgomery Street, Financial District, San Francisco, California, 94111, United States  | 37.79520| -122.40279|
-|West Adams Street, Printer's Row, Loop, Chicago, Cook County, Illinois, 60606, United States  | 41.87874| -87.63589|
+|address_found | lat| lon|
+|:-----------------------------------------------------------------------------------------------------------------------------------|--------:|----------:|
+|Zastava Sjedinjenih Američkih Država, Pennsylvania Avenue Northwest, Ward 2, Washington, District of Columbia, 20006, United States | 38.89772| -77.03655|
+|Transamerica Pyramid, 600, Montgomery Street, Financial District, San Francisco, California, 94111, United States | 37.79520| -122.40279|
+|Willis Tower, 233, South Wacker Drive, Printer's Row, Loop, Chicago, Cook County, Illinois, 60606, United States | 41.87874| -87.63596|