Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Jul 24, 2024
1 parent cca6376 commit f4bf88d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 3 deletions.
15 changes: 15 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ license: MIT
title: 'nominatimlite: Interface with ''Nominatim'' API Service'
version: 0.4.1
doi: 10.32614/CRAN.package.nominatimlite
identifiers:
- type: doi
value: 10.32614/CRAN.package.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.
Expand Down Expand Up @@ -92,6 +95,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0003-4777-038X
year: '2024'
doi: 10.32614/CRAN.package.dplyr
version: '>= 1.0.0'
- type: software
title: jsonlite
Expand All @@ -105,6 +109,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
doi: 10.32614/CRAN.package.jsonlite
version: '>= 1.7.0'
- type: software
title: sf
Expand All @@ -118,6 +123,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0001-8049-7069
year: '2024'
doi: 10.32614/CRAN.package.sf
version: '>= 0.9.0'
- type: software
title: utils
Expand All @@ -129,6 +135,7 @@ references:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2024'
doi: 10.32614/CRAN.package.utils
- type: software
title: arcgeocoder
abstract: 'arcgeocoder: Geocoding with the ''ArcGIS'' REST API Service'
Expand All @@ -141,6 +148,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0001-8457-4658
year: '2024'
doi: 10.32614/CRAN.package.arcgeocoder
- type: software
title: ggplot2
abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
Expand Down Expand Up @@ -180,6 +188,7 @@ references:
name-particle: van den
orcid: https://orcid.org/0000-0002-9335-7468
year: '2024'
doi: 10.32614/CRAN.package.ggplot2
version: '>= 3.0.0'
- type: software
title: knitr
Expand All @@ -193,6 +202,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0003-0645-5666
year: '2024'
doi: 10.32614/CRAN.package.knitr
- type: software
title: lifecycle
abstract: 'lifecycle: Manage the Life Cycle of your Package Functions'
Expand All @@ -208,6 +218,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0003-4757-117X
year: '2024'
doi: 10.32614/CRAN.package.lifecycle
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
Expand Down Expand Up @@ -251,6 +262,7 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0003-3925-190X
year: '2024'
doi: 10.32614/CRAN.package.rmarkdown
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
Expand All @@ -262,6 +274,7 @@ references:
given-names: Hadley
email: [email protected]
year: '2024'
doi: 10.32614/CRAN.package.testthat
version: '>= 3.0.0'
- type: software
title: tibble
Expand All @@ -278,6 +291,7 @@ references:
given-names: Hadley
email: [email protected]
year: '2024'
doi: 10.32614/CRAN.package.tibble
- type: software
title: tidygeocoder
abstract: 'tidygeocoder: Geocoding Made Easy'
Expand All @@ -302,4 +316,5 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0002-6738-9845
year: '2024'
doi: 10.32614/CRAN.package.tidygeocoder

4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r
[![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)
[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite)
[![r-universe](https://dieghernan.r-universe.dev/badges/nominatimlite)](https://dieghernan.r-universe.dev/nominatimlite)
[![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)
Expand Down Expand Up @@ -94,7 +95,8 @@ You can install the developing version of **nominatimlite** with:
remotes::install_github("dieghernan/nominatimlite")
```

Alternatively, you can install **nominatimlite** using the **r-universe**:
Alternatively, you can install **nominatimlite** using the
[r-universe](https://dieghernan.r-universe.dev/nominatimlite):

```{r, eval=FALSE}
# Install nominatimlite in R:
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ results](https://badges.cranchecks.info/worst/nominatimlite.svg)](https://cran.r
[![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)
[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/nominatimlite/badge)](https://www.codefactor.io/repository/github/dieghernan/nominatimlite)
[![r-universe](https://dieghernan.r-universe.dev/badges/nominatimlite)](https://dieghernan.r-universe.dev/nominatimlite)
[![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)
Expand Down Expand Up @@ -78,7 +79,7 @@ remotes::install_github("dieghernan/nominatimlite")
```

Alternatively, you can install **nominatimlite** using the
**r-universe**:
[r-universe](https://dieghernan.r-universe.dev/nominatimlite):

``` r
# Install nominatimlite in R:
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "250.421KB",
"fileSize": "250.632KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand Down
Binary file modified man/figures/README-pizzahut-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 f4bf88d

Please sign in to comment.