Repository files navigation

Geocode with theOpenCage API, either fromplace name to longitude and latitude (forward geocoding) or fromlongitude and latitude to the name and address of the location (reversegeocoding).

You can install {opencage} fromCRAN,R-universe orGitHub like this:

• Release version from CRAN

  install.packages("opencage")

• Development version from R-universe

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

• Development version from GitHub with{pak}

  pak::pak("ropensci/opencage")

  or with {remotes}

  remotes::install_github("ropensci/opencage")

For the best experience, we recommend that you read through the“Introduction toopencage”vignette (vignette("opencage")), but if you are in a hurry:

1. Register atopencagedata.com/users/sign_up.
2. Generate an API key at theOpenCagedashboard.
3. Save your API key as anenvironmentvariable likeOPENCAGE_KEY=yourkey in.Renviron. Seehelp(oc_config) foralternative ways to set your OpenCage API key.

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

library(opencage)oc_forward_df(placename="Sarzeau")

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

oc_reverse_df(latitude=51.5034070,longitude=-0.1275920)

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

• “Introduction toopencage”vignette("opencage")
• “Customise yourquery”vignette("customise_query")
• “Outputoptions”vignette("output_options")

TheOpenCage API supports forward andreverse geocoding. Sources of OpenCage are open geospatial dataincludingOpenStreetMap,DataScienceToolkit,GeoPlanet,Natural EarthData,libpostal,GeoNames, andFlickr’sshapefilesplus a whole lot more besides. Refer to the current fulllist ofcredits.

Please note that this package is released with aContributor Code ofConduct. By contributing to thisproject, you agree to abide by its terms.