opencage

:globe_with_meridians: R package for the OpenCage API -- both forward and reverse geocoding :globe_with_meridians:

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 13 committers (7.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary

Keywords

geocode geocoder opencage opencage-api opencage-geocoder peer-reviewed placenames r r-package rspatial rstats

Keywords from Contributors

genome overpass-api air-pollution taxize sequenced-genomes proteome ncbi-genbank metagenomics meta-analysis genome-retrieval

Last synced: 6 months ago · JSON representation ·

Repository

:globe_with_meridians: R package for the OpenCage API -- both forward and reverse geocoding :globe_with_meridians:

Basic Info

Host: GitHub
Owner: ropensci
Language: R
Default Branch: main
Homepage: https://docs.ropensci.org/opencage
Size: 1010 KB

Statistics

Stars: 87
Watchers: 8
Forks: 11
Open Issues: 5
Releases: 4

Topics

geocode geocoder opencage opencage-api opencage-geocoder peer-reviewed placenames r r-package rspatial rstats

Created almost 10 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing Citation

README.Rmd

---
output:
  github_document:
    df_print: kable
---



# opencage



[![CRAN Version](https://www.r-pkg.org/badges/version/opencage)](https://cran.r-project.org/package=opencage)
[![CRAN Checks Status](https://badges.cranchecks.info/worst/opencage.svg)](https://cran.r-project.org/web/checks/check_results_opencage.html)
[![CRAN Downloads per Month](https://cranlogs.r-pkg.org/badges/opencage)](https://cran.r-project.org/package=opencage)
[![R-universe status](https://ropensci.r-universe.dev/badges/opencage)](https://ropensci.r-universe.dev/ui#package:opencage)
[![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)
[![R-CMD-check Status on GitHub Actions](https://github.com/ropensci/opencage/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/opencage/actions?query=workflow%3AR-CMD-check)
[![codecov.io Status](https://codecov.io/github/ropensci/opencage/coverage.svg?branch=main)](https://codecov.io/github/ropensci/opencage?branch=main)
[![rOpenSci Peer-Review](https://badges.ropensci.org/36_status.svg)](https://github.com/ropensci/software-review/issues/36)
[![License](https://img.shields.io/cran/l/opencage)](https://opensource.org/licenses/gpl-license)



Geocode with the [OpenCage](https://opencagedata.com) API, either from place name to longitude and latitude (forward geocoding) or from longitude and latitude to the name and address of the location (reverse geocoding).

## Installation

You can install {opencage} from [CRAN](https://cran.r-project.org/package=opencage), [R-universe](https://ropensci.r-universe.dev/ui#package:opencage) or [GitHub](https://github.com/ropensci/opencage) like this:

- Release version from CRAN

  ```r
  install.packages("opencage")
  ```

- Development version from R-universe
  
  ```r
  install.packages(
    "opencage", 
    repos = c("https://ropensci.r-universe.dev", getOption("repos"))
  )
  ```

- Development version from GitHub with {[pak](https://github.com/r-lib/pak/)}
  
  ```r
  pak::pak("ropensci/opencage")
  ```
  
  or with {[remotes](https://github.com/r-lib/remotes/)}
  
  ```r
  remotes::install_github("ropensci/opencage")
  ```

## Quickstart

For the best experience, we recommend that you read through the "[Introduction to opencage](https://docs.ropensci.org/opencage/articles/opencage.html)" vignette (`vignette("opencage")`), but if you are in a hurry:

1.  Register at [opencagedata.com/users/sign_up](https://opencagedata.com/users/sign_up).
2.  Generate an API key at the [OpenCage dashboard](https://opencagedata.com/dashboard#api-keys).
3.  Save your API key as an [environment variable](https://rstats.wtf/r-startup.html#renviron) like `OPENCAGE_KEY=yourkey` in `.Renviron`. 
    See `help(oc_config)` for alternative ways to set your OpenCage API key.

Now you are ready to turn place names into latitude and longitude coordinates:

```{r forward}
library(opencage)
oc_forward_df(placename = "Sarzeau")
```

Or turn a set of coordinates into the name and address of the location:

```{r reverse}
oc_reverse_df(latitude = 51.5034070, longitude = -0.1275920)
```

But remember, the vignettes are really great! We have:

- "[Introduction to opencage](https://docs.ropensci.org/opencage/articles/opencage.html)" `vignette("opencage")`
- "[Customise your query](https://docs.ropensci.org/opencage/articles/customise_query.html)" `vignette("customise_query")`
- "[Output options](https://docs.ropensci.org/opencage/articles/output_options.html)" `vignette("output_options")`

## About OpenCage

The [OpenCage](https://opencagedata.com) API supports forward and reverse geocoding. 
Sources of OpenCage are open geospatial data including
[OpenStreetMap](https://www.openstreetmap.org),
[DataScienceToolkit](https://github.com/petewarden/dstk),
[GeoPlanet](https://en.wikipedia.org/wiki/GeoPlanet), 
[Natural Earth Data](https://www.naturalearthdata.com),
[libpostal](https://github.com/openvenues/libpostal),
[GeoNames](https://www.geonames.org), and 
[Flickr's shapefiles](https://code.flickr.net/2009/05/21/flickr-shapefiles-public-dataset-10/)
plus a whole lot more besides. 
Refer to the current full [list of credits](https://opencagedata.com/credits).

## Code of Conduct

Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). 
By contributing to this project, you agree to abide by its terms.

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "opencage" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'opencage: Geocode with the OpenCage API'
version: 0.2.2.9000
doi: 10.32614/CRAN.package.opencage
abstract: Geocode with the OpenCage API, either from place name to longitude and latitude
  (forward geocoding) or from longitude and latitude to the name and address of a
  location (reverse geocoding), see <https://opencagedata.com>.
authors:
- family-names: Possenriede
  given-names: Daniel
  email: possenriede+r@gmail.com
  orcid: https://orcid.org/0000-0002-6738-9845
- family-names: Sadler
  given-names: Jesse
  orcid: https://orcid.org/0000-0001-6081-9681
- family-names: Salmon
  given-names: Maëlle
  orcid: https://orcid.org/0000-0002-2815-0399
repository: https://CRAN.R-project.org/package=opencage
repository-code: https://github.com/ropensci/opencage
url: https://docs.ropensci.org/opencage/
contact:
- family-names: Possenriede
  given-names: Daniel
  email: possenriede+r@gmail.com
  orcid: https://orcid.org/0000-0002-6738-9845
keywords:
- geocode
- geocoder
- opencage
- opencage-api
- opencage-geocoder
- peer-reviewed
- placenames
- r
- r-package
- rspatial
- rstats

GitHub Events

Total

Issues event: 8
Watch event: 3
Delete event: 3
Issue comment event: 20
Push event: 16
Pull request review comment event: 10
Pull request review event: 10
Pull request event: 5
Create event: 4

Last Year

Issues event: 8
Watch event: 3
Delete event: 3
Issue comment event: 20
Push event: 16
Pull request review comment event: 10
Pull request review event: 10
Pull request event: 5
Create event: 4

Committers

Last synced: about 2 years ago

All Time

Total Commits: 459
Total Committers: 13
Avg Commits per committer: 35.308
Development Distribution Score (DDS): 0.349

Past Year

Commits: 13
Committers: 2
Avg Commits per committer: 6.5
Development Distribution Score (DDS): 0.077

Top Committers

Name	Email	Commits
Daniel Possenriede	p**e@g**m	299
Maëlle Salmon	m**n@y**e	116
Jesse Sadler	j**r@u**u	15
Jake Russ	j**s@g**m	9
msalmon	m**n@I**N	7
Daniel Possenriede	p**r@g**m	4
Daniel Possenriede	1****n	3
Noam Ross	n**s@o**l	1
rOpenSci Bot	m**t@g**m	1
Jesse Sadler	2****r	1
Karthik Ram	k**m@g**m	1
Marie Vaugoyeau	3****u	1
Ed Freyfogle	f****e	1

Committer Domains (Top 20 + Academic)

isglobal.lan: 1 ucla.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 37
Total pull requests: 76
Average time to close issues: 11 months
Average time to close pull requests: about 2 months
Total issue authors: 9
Total pull request authors: 6
Average comments per issue: 2.97
Average comments per pull request: 1.57
Merged pull requests: 59
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 4
Pull requests: 7
Average time to close issues: about 1 month
Average time to close pull requests: 17 days
Issue authors: 3
Pull request authors: 1
Average comments per issue: 3.75
Average comments per pull request: 1.86
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

dpprdan (18)
maelle (9)
jessesadler (4)
freyfogle (2)
mariofajardo (1)
lsong07 (1)
charliejhadley (1)
ddunn801 (1)
jeroen (1)

Pull Request Authors

dpprdan (64)
maelle (3)
jessesadler (3)
charliejhadley (3)
kejrol (1)
karthik (1)

Top Labels

Issue Labels

wontfix (1)

Pull Request Labels

enhancement (1) bug (1)

Packages

Total packages: 1
Total downloads:
- cran 564 last-month
Total docker downloads: 132,008

Total dependent packages: 1
Total dependent repositories: 2
Total versions: 5
Total maintainers: 1

cran.r-project.org: opencage

Geocode with the OpenCage API

Homepage: https://docs.ropensci.org/opencage/
Documentation: http://cran.r-project.org/web/packages/opencage/opencage.pdf
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
Latest release: 0.2.2
published about 5 years ago

Versions: 5
Dependent Packages: 1
Dependent Repositories: 2
Downloads: 564 Last month
Docker Downloads: 132,008

Rankings

Docker downloads count: 0.0%

Stargazers count: 4.3%

Forks count: 6.3%

Average: 12.6%

Dependent packages count: 18.1%

Dependent repos count: 19.2%

Downloads: 27.5%

Maintainers (1)

possenriede+r@gmail.com

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

crul >= 0.5.2 imports
dplyr >= 0.7.4 imports
jsonlite >= 1.5 imports
lifecycle * imports
memoise >= 1.1.0 imports
progress >= 1.1.2 imports
purrr >= 0.2.4 imports
ratelimitr >= 0.4.0 imports
rlang * imports
tibble >= 1.4.2 imports
tidyr >= 0.8.0 imports
withr >= 2.0.0 imports
knitr >= 1.19 suggests
mockery * suggests
rmarkdown >= 1.8 suggests
sf >= 0.9 suggests
testthat >= 3.1.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/lint.yaml actions

actions/checkout v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/update-citation-cff.yaml actions

actions/checkout v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/document.yaml actions

actions/checkout v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/style.yaml actions

actions/cache v3 composite
actions/checkout v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite