Skip to content

Commit

Permalink
CRAN release
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Sep 30, 2021
1 parent adc8736 commit 5a2a821
Show file tree
Hide file tree
Showing 14 changed files with 111 additions and 51 deletions.
20 changes: 17 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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.1.0.9000
version: 0.1.1
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
Expand All @@ -20,13 +20,14 @@ authors:
orcid: https://orcid.org/0000-0001-8457-4658
preferred-citation:
type: manual
title: 'nominatimlite: Interface with Nominatim API Service'
title: 'nominatimlite: Interface with ''Nominatim'' API Service'
authors:
- family-names: Hernangómez
given-names: Diego
year: '2021'
url: https://dieghernan.github.io/nominatimlite/
version: 0.1.1
doi: 10.5281/zenodo.5113195
url: https://dieghernan.github.io/nominatimlite/
repository: https://CRAN.R-project.org/package=nominatimlite
repository-code: https://github.com/dieghernan/nominatimlite
url: https://dieghernan.github.io/nominatimlite/
Expand All @@ -35,3 +36,16 @@ contact:
given-names: Diego
email: [email protected]
orcid: https://orcid.org/0000-0001-8457-4658
keywords:
- r
- geocoding
- openstreetmap
- address
- nominatim
- reverse-geocoding
- rstats
- shapefile
- r-package
- spatial
- cran
- api-wrapper
26 changes: 13 additions & 13 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
Type: Package
Package: nominatimlite
Title: Interface with 'Nominatim' API Service
Version: 0.1.0.9000
Authors@R:
c(person(given = "Diego",
family = "Hernangómez",
role = c("aut", "cre", "cph"),
email = "[email protected]",
comment = c(ORCID = "0000-0001-8457-4658")),
person(given = "Jindra",
family = "Lacko",
role = c("ctb", "rev")),
person(given = "OpenStreetMap contributors",
role = "cph",
comment = "for the data."))
Version: 0.1.1
Authors@R: c(
person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0001-8457-4658")),
person("Jindra", "Lacko", role = c("ctb", "rev")),
person("OpenStreetMap contributors", role = "cph",
comment = "for the data.")
)
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,
Expand All @@ -40,9 +35,14 @@ Suggests:
VignetteBuilder:
knitr
Config/testthat/edition: 3
Config/testthat/parallel: true
Copyright: Data (c) OpenStreetMap contributors, ODbL 1.0.
<https://www.openstreetmap.org/copyright>
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
X-schema.org-applicationCategory: cartography
X-schema.org-keywords: r, geocoding, openstreetmap, address, nominatim,
reverse-geocoding, rstats, shapefile, r-package, spatial, cran,
api-wrapper
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nominatimlite (development version)
# nominatimlite 0.1.1

- Adapt tests to **CRAN** checks.

Expand Down
1 change: 0 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ results](https://cranchecks.info/badges/worst/nominatimlite)](https://cran.r-pro
[![r-universe](https://dieghernan.r-universe.dev/badges/nominatimlite)](https://dieghernan.r-universe.dev/)
[![Project Status: Active – The project has reached a stable, usable 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)
[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite)
[![status](https://tinyverse.netlify.com/badge/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)

<!-- badges: end -->
Expand Down
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ results](https://cranchecks.info/badges/worst/nominatimlite)](https://cran.r-pro
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)
[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite)
[![status](https://tinyverse.netlify.com/badge/nominatimlite)](https://CRAN.R-project.org/package=nominatimlite)

<!-- badges: end -->
Expand Down Expand Up @@ -47,10 +46,10 @@ overcome this limitation.
There are other packages much more complete and mature than
`nominatimlite`, that presents similar features:

- [`tidygeocoder`](https://jessecambon.github.io/tidygeocoder/) by
- [`tidygeocoder`](https://jessecambon.github.io/tidygeocoder/) by
Jesse Cambon. Allows to interface with Nominatim, Google, TomTom,
Mapbox, etc. for geocoding and reverse geocoding.
- [`osmdata`](https://docs.ropensci.org/osmdata/) by Mark Padgham.
- [`osmdata`](https://docs.ropensci.org/osmdata/) by Mark Padgham.
Great for downloading spatial data from OpenStreetMap, via the
[Overpass API](https://wiki.openstreetmap.org/wiki/Overpass_API).

Expand Down Expand Up @@ -161,11 +160,11 @@ Only latitude and longitude are returned from the geocoder service in
this example, but `full_results = TRUE` can be used to return all of the
data from the geocoder service.

| query | latitude | longitude | address |
| :----------------------------------------- | -------: | ----------: | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1600 Pennsylvania Ave NW, Washington, DC | 38.89770 | \-77.03655 | White House, 1600, Pennsylvania Avenue Northwest, Washington, District of Columbia, 20500, United States |
| 600 Montgomery St, San Francisco, CA 94111 | 37.79520 | \-122.40279 | Transamerica Pyramid, 600, Montgomery Street, Chinatown, San Francisco, San Francisco City and County, San Francisco, California, 94111, United States |
| 233 S Wacker Dr, Chicago, IL 60606 | 41.87887 | \-87.63591 | Willis Tower, 233, South Wacker Drive, Printer’s Row, Loop, Chicago, Cook County, Illinois, 60606, United States |
| query | latitude | longitude | address |
|:-------------------------------------------|---------:|-----------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1600 Pennsylvania Ave NW, Washington, DC | 38.89770 | -77.03655 | White House, 1600, Pennsylvania Avenue Northwest, Washington, District of Columbia, 20500, United States |
| 600 Montgomery St, San Francisco, CA 94111 | 37.79520 | -122.40279 | Transamerica Pyramid, 600, Montgomery Street, Chinatown, San Francisco, San Francisco City and County, San Francisco, California, 94111, United States |
| 233 S Wacker Dr, Chicago, IL 60606 | 41.87887 | -87.63591 | Willis Tower, 233, South Wacker Drive, Printer’s Row, Loop, Chicago, Cook County, Illinois, 60606, United States |

To perform reverse geocoding (obtaining addresses from geographic
coordinates), we can use the `reverse_geo_lite()` function. The
Expand All @@ -181,11 +180,11 @@ reverse <- reverse_geo_lite(
)
```

| address\_found | lat | lon |
| :----------------------------------------------------------------------------------------------------------------------------------------------------- | -------: | ----------: |
| White House, 1600, Pennsylvania Avenue Northwest, Washington, District of Columbia, 20500, United States | 38.89770 | \-77.03655 |
| Transamerica Pyramid, 600, Montgomery Street, Chinatown, San Francisco, San Francisco City and County, 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.87887 | \-87.63591 |
| address\_found | lat | lon |
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|---------:|-----------:|
| White House, 1600, Pennsylvania Avenue Northwest, Washington, District of Columbia, 20500, United States | 38.89770 | -77.03655 |
| Transamerica Pyramid, 600, Montgomery Street, Chinatown, San Francisco, San Francisco City and County, 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.87887 | -87.63591 |

For more advance users, see [Nominatim
docs](https://nominatim.org/release-docs/latest/api/Search/) to check
Expand All @@ -200,17 +199,20 @@ citation("nominatimlite")
#>
#> To cite the 'nominatimlite' package in publications use:
#>
#> Hernangómez, D (2021). nominatimlite: Interface with Nominatim API
#> Service. http://doi.org/10.5281/zenodo.5113195. Package url:
#> https://dieghernan.github.io/nominatimlite/
#> Hernangómez D (2021). _nominatimlite: Interface with 'Nominatim' API
#> Service_. doi: 10.5281/zenodo.5113195 (URL:
#> https://doi.org/10.5281/zenodo.5113195), R package version 0.1.1, <URL:
#> https://dieghernan.github.io/nominatimlite/>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {nominatimlite: Interface with Nominatim API Service},
#> author = {Diego Hernangómez},
#> title = {nominatimlite: Interface with 'Nominatim' API Service},
#> year = {2021},
#> url = {https://dieghernan.github.io/nominatimlite/},
#> note = {R package version 0.1.1},
#> version = {0.1.1},
#> author = {Diego Hernangómez},
#> doi = {10.5281/zenodo.5113195},
#> url = {https://dieghernan.github.io/nominatimlite/},
#> }
```
9 changes: 6 additions & 3 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"relatedLink": "https://dieghernan.github.io/nominatimlite/",
"issueTracker": "https://github.com/dieghernan/nominatimlite/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.1.0.9000",
"version": "0.1.1",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -201,7 +201,9 @@
},
"SystemRequirements": null
},
"fileSize": "274.025KB",
"applicationCategory": "cartography",
"keywords": ["r", "geocoding", "openstreetmap", "address", "nominatim", "reverse-geocoding", "rstats", "shapefile", "r-package", "spatial", "cran", "api-wrapper"],
"fileSize": "184.99KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand All @@ -213,9 +215,10 @@
"familyName": "Hernangómez"
}
],
"name": "nominatimlite: Interface with Nominatim API Service",
"name": "nominatimlite: Interface with 'Nominatim' API Service",
"identifier": "10.5281/zenodo.5113195",
"url": "https://dieghernan.github.io/nominatimlite/",
"description": "R package version 0.1.1",
"@id": "https://doi.org/10.5281/zenodo.5113195",
"sameAs": "https://doi.org/10.5281/zenodo.5113195"
}
Expand Down
Binary file modified data/osm_amenities.rda
Binary file not shown.
21 changes: 10 additions & 11 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
citHeader("To cite the 'nominatimlite' package in publications use:")
year <- format(Sys.time(), "%Y")

year = format(Sys.time(), "%Y")
url = 'https://dieghernan.github.io/nominatimlite/'

citEntry(
entry = 'manual',
title = paste('nominatimlite:', "Interface with Nominatim API Service"),
author = "Diego Hernangómez",
bibentry(
"Manual",
header = "To cite the 'nominatimlite' package in publications use:",
title = paste("nominatimlite:", meta$Title),
year = year,
url = url,
doi = '10.5281/zenodo.5113195',
textVersion = paste0('Hernangómez, D (', year, '). nominatimlite: Interface with Nominatim API Service. http://doi.org/10.5281/zenodo.5113195. Package url: ', url)
note = paste("R package version", meta$Version),
version = meta$Version,
author = person("Diego", "Hernangómez"),
doi = "10.5281/zenodo.5113195",
url = unlist(strsplit(meta$URL, ","))[1]
)
43 changes: 43 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
CMD
Cambon
CodeFactor
DOI
Geocode
Geocodes
Geocoding
Mapbox
McDonalds
Nominatim
ORCID
OSM
OpenStreetMap
Padgham
TomTom
Transamerica
atm
bbq
behaviour
biergarten
centre
codecov
de
dieghernan
geocode
geocoded
geocoder
geocodes
geocoding
geolocated
github
https
ie
io
lon
nominatim
osm
penta
stripclub
swingerclub
theatre
townhall
vectorized
Binary file modified man/figures/README-McDonalds-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-line-object-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-penta-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vignettes/McDonalds-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vignettes/penta-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5a2a821

Please sign in to comment.