https://github.com/wmgeolab/rgeoboundaries

R client to geoBoundaries: A Political Administrative Boundaries Dataset -
https://github.com/wmgeolab/rgeoboundaries

Last synced: about 2 months ago
JSON representation

R client to geoBoundaries: A Political Administrative Boundaries Dataset -

• Host: GitHub
• URL: https://github.com/wmgeolab/rgeoboundaries
• Owner: wmgeolab
• License: other
• Created: 2020-04-30T17:02:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T15:33:22.000Z (4 months ago)
• Last Synced: 2024-07-14T03:24:24.251Z (2 months ago)
• Language: R
• Homepage: https://github.com/wmgeolab/rgeoboundaries
• Size: 16.1 MB
• Stars: 64
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%",

  dev = "svg"

)

```

# rgeoboundaries 

[![GitLab CI Build Status](https://gitlab.com/dickoa/rgeoboundaries/badges/master/pipeline.svg)](https://gitlab.com/dickoa/rgeoboundaries/pipelines)

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/gitlab/dickoa/rgeoboundaries?branch=master&svg=true)](https://ci.appveyor.com/project/dickoa/rgeoboundaries)

[![Codecov Code Coverage](https://codecov.io/gl/dickoa/rgeoboundaries/branch/master/graph/badge.svg)](https://codecov.io/gl/dickoa/rgeoboundaries)

[![CRAN status](https://www.r-pkg.org/badges/version/rgeoboundaries)](https://cran.r-project.org/package=rgeoboundaries)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`rgeoboundaries` is an R client for the [geoBoundaries API](https://www.geoboundaries.org/), providing country political administrative boundaries.

## Installation

You can install the development version of rgeoboundaries using the `remotes` package:

``` {r, eval = FALSE}

# install.packages("remotes")

remotes::install_gitlab("dickoa/rgeoboundaries")

remotes::install_github("wmgeolab/rgeoboundaries")

```

## Access administrative boundaries using rgeoboundaries

This is a basic example which shows you how get Mali and Senegal boundaries and plot it

```{r plot, cache = TRUE}

library(rgeoboundaries)

library(sf)

mli_sen <- gb_adm0(c("mali", "senegal"), type = "sscgs")

plot(st_geometry(mli_sen))

```

We can also get the first administrative division of all countries in the world and use ISO3 code too

```{r plot_egy, cache = TRUE}

egy <- gb_adm1("EGY")

plot(st_geometry(egy),

     col = rgb(red = 1, green = 0, blue = 0, alpha = 0.5),

     axes = TRUE, graticule = TRUE)

```

In order to access the global administrative zones, you just need to skip the country argument (i.e set it to `NULL`) or specify `type = "CGAZ"`.

```{r plot_world, cache = TRUE}

world <- gb_adm1()

world_lambert <- st_transform(world, "+proj=laea +x_0=0 +y_0=0 +lon_0=0 +lat_0=0")

par(bty = "n")

plot(st_geometry(world_lambert),

     col = "#E39d57",

     graticule = TRUE, lwd = 0.3)

```

Finally, metadata for each country and administrative level are also available.

```{r, metadata}

knitr::kable(gb_metadata(c("mali", "senegal"), "adm1"))

```

## How to to cite

If you are using this package in your analysis, please cite the original `geoBoundaries` work:

> Runfola D, Anderson A, Baier H, Crittenden M, Dowker E, Fuhrig S, et al. (2020) geoBoundaries: A global database of political administrative boundaries. PLoS ONE 15(4): e0231866. https://doi.org/10.1371/journal.pone.0231866