zonebuilder

R-CMD-check CRAN status

The goal of zonebuilder is to break up large geographic regions such as cities into manageable zones. Zoning systems are important in many fields, including demographics, economy, health, and transport. The zones have standard configuration, which enabled comparability across cities. See its website at zonebuilders.github.io/zonebuilder.

Installation

You can install the released version of zonebuilder from CRAN with:

install.packages("zonebuilder")

Install it from GitHub with:

# install.packages("remotes")
remotes::install_github("zonebuilders/zonebuilder")

Using zonebuilder

Zonebuilder builds on the sf package and works well with mapping packages such as ggplot2, leaflet, mapdeck, mapview and tmap, the last of which we’ll use in the following maps. Attaching the package provides the example datasets london_a() and london_c(), the geographic boundary and the centre of London:

library(zonebuilder)
library(tmap)
tm_shape(london_a()) + tm_borders() + tm_shape(london_c()) + tm_dots("red")

The main function zb_zone breaks this geographical scale into zones. The default settings follow the ClockBoard configuration:

london_zones <- zb_zone(london_c(), london_a())
zb_plot(london_zones)

The idea behind this zoning system is based on the following principles:

The package zonebuilder does not only create zoning systems based on the CloadBoard layout as illustrated below.

The function zb_zone makes use of zb_doughnut and zb_segment, which can also be used directly:

par(mfrow = c(1, 3))
zb_plot(zb_doughnut(london_c(), london_a(), n_circles = 5), title = "Doughnuts")

zb_plot(zb_segment(london_c(), n_segments = 20), title = "Segments")

zb_plot(zb_zone(london_c(), n_circles = 4, n_segments = 4), title = "4 segments, 4 circles")

The package also contains a function to create zones based on a simple rectangular grid system:

z = zb_quadrat(london_a(), ncol = 10)
plot(z)

Contribute

Contributions are welcome!

It may be worth checking-in in a discussion post before opening an issue.

Citation

Watch this space.