1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
<!-- README.md is generated from README.Rmd. Please edit that file -->
# areal <img src="man/figures/arealLogo.png" align="right" />
[](https://github.com/chris-prener/areal/actions)
[](https://codecov.io/github/chris-prener/areal?branch=main)
[](https://cran.r-project.org/package=areal)
[](https://cran.r-project.org/web/checks/check_results_areal.html)
[](https://www.r-pkg.org/pkg/areal)
[](https://zenodo.org/badge/latestdoi/152279647)
[](https://doi.org/10.21105/joss.01221)
Areal interpolation is the process making estimates from a source set of
polygons to an overlapping but incongruent set of target polygons. One
challenge with areal interpolation is that, while the processes
themselves are well documented in the academic literature, implementing
them often involves “reinventing the wheel” by re-creating the process
in the analyst’s tool choice.
While the `R` package `sf` does offer a basic interface for areal
weighted interpolation (`st_interpolate_aw`), it lacks some features
that we use in our work. The `areal` package contains a suite tools for
validation and estimation, providing a full-featured workflow that fits
into both modern data management (e.g. `tidyverse`) and spatial data
(e.g. `sf`) frameworks.
### *Joural of Open Souce Software* Article
An [article](https://joss.theoj.org/papers/10.21105/joss.01221)
describing `areal`’s approach to areal weighted interpolation has been
published in the [*The Journal of Open Source
Software*](https://joss.theoj.org/). The article includes benchmarking
of `areal` performance on several data sets. Please [cite the
paper](/inst/CITATION) if you use `areal` in your work!
## Installation
The easiest way to get `areal` is to install it from CRAN:
``` r
install.packages("areal")
```
The development version of `areal` can be accessed from GitHub with
`remotes`:
``` r
# install.packages("remotes")
remotes::install_github("chris-prener/areal")
```
Note that installations that require `sf` to be built from *source* will
require additional software regardless of operating system. You should
check the [`sf` package website](https://r-spatial.github.io/sf/) for
the latest details on installing dependencies for that package.
Instructions vary significantly by operating system.
## Usage
Two function prefixes are used in `areal` to allow users to take
advantage of RStudio’s auto complete functionality:
- `ar_` - data and functions that are used for multiple interpolation
methods
- `aw_` - functions that are used specifically for areal weighted
interpolation
### Data
The package contains four overlapping data sets:
- `ar_stl_race` (2017 ACS demographic counts at the census tract
level; *n* = 106)
- `ar_stl_asthma` (2017 asthma rates at the census tract level; *n*
= 106)
- `ar_stl_wards` (the 2010 political subdivisions in St. Louis; *n* =
28).
- `ar_stl_wardsClipped` (the 2010 political subdivisions in St. Louis
clipped to the Mississippi River shoreline; *n* = 28).
These can be used to illustrate the core functionality of the package.
The following examples assume:
``` r
> library(areal)
>
> race <- ar_stl_race
> asthma <- ar_stl_asthma
> wards <- ar_stl_wards
```
### Areal Weighted Interpolation
`areal` currently implements an approach to interpolation known as areal
weighted interpolation. It is arguably the simplest and most common
approach to areal interpolation, though it does have some drawbacks (see
the [areal weighted interpolation
vignette](https://chris-prener.github.io/areal/articles/areal-weighted-interpolation.html)
for details). The basic usage of `areal` is through the
`aw_interpolate()` function. This is a pipe-able function that allows
for the simultaneous interpolation of multiple values.
In this first example, the total estimated population (`TOTAL_E`) of
each ward is calculated from its overlapping census tracts:
``` r
aw_interpolate(wards, tid = WARD, source = race, sid = "GEOID",
weight = "sum", output = "sf", extensive = "TOTAL_E")
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> Simple feature collection with 28 features and 4 fields
#> Geometry type: POLYGON
#> Dimension: XY
#> Bounding box: xmin: 733361.8 ymin: 4268336 xmax: 746157.7 ymax: 4295504
#> Projected CRS: NAD83 / UTM zone 15N
#> First 10 features:
#> OBJECTID WARD AREA TOTAL_E geometry
#> 1 1 1 46138761 7991.565 POLYGON ((740184.2 4286431,...
#> 2 2 2 267817711 12145.021 POLYGON ((742392.1 4289178,...
#> 3 3 3 66291644 7344.287 POLYGON ((742956.1 4284113,...
#> 4 4 4 53210707 8457.672 POLYGON ((739557.6 4284080,...
#> 5 5 5 60462396 8783.377 POLYGON ((744883.8 4281632,...
#> 6 6 6 64337271 14050.399 POLYGON ((742501.6 4279976,...
#> 7 7 7 101268146 15840.086 POLYGON ((745618.6 4279867,...
#> 8 8 8 45966410 12188.131 POLYGON ((739842.8 4277724,...
#> 9 9 9 73993891 14217.149 POLYGON ((742619.4 4276734,...
#> 10 10 10 62915358 11239.213 POLYGON ((737257.7 4277050,...
```
This example outputs a simple features (`sf`) object and uses one of two
options for calculating weights. All of these arguments are documented
both within the package (use `?aw_interpolate`) and on the [package’s
website](https://chris-prener.github.io/areal/).
What results from `aw_interpolate()` is mapped below. Total population
per census tract in St. Louis is mapped on the left in panel A. Using
`aw_interpolate()` as we did in the previous example, we estimate
population counts for Wards in St. Louis from those census tract values.
These estimated values are mapped on the right in panel B.
<img src="man/figures/exampleMap.png" width="100%" />
Both extensive and intensive data can be interpolated simultaneously by
using both the `extensive` and `intensive` arguments. In this second
example, the asthma and race data are combined, and estimates for both
the population values and asthma rates are calculated for each ward from
its overlapping census tracts:
``` r
# remove sf geometry
st_geometry(race) <- NULL
# create combined data
race %>%
select(GEOID, TOTAL_E, WHITE_E, BLACK_E) %>%
left_join(asthma, ., by = "GEOID") -> combinedData
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
# interpolate
wards %>%
select(-OBJECTID, -AREA) %>%
aw_interpolate(tid = WARD, source = combinedData, sid = "GEOID",
weight = "total", output = "tibble",
extensive = c("TOTAL_E", "WHITE_E", "BLACK_E"),
intensive = "ASTHMA")
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> old-style crs object detected; please recreate object with a recent sf::st_crs()
#> # A tibble: 28 × 5
#> WARD BLACK_E TOTAL_E WHITE_E ASTHMA
#> <int> <dbl> <dbl> <dbl> <dbl>
#> 1 1 7778. 7991. 153. 13.4
#> 2 2 10552. 12042. 1308. 13.2
#> 3 3 6627. 7334. 589. 14.1
#> 4 4 8203. 8458. 160. 13.6
#> 5 5 6971. 8689. 1518. 13.8
#> 6 6 7418. 14022. 5833. 11.7
#> 7 7 6544. 15645. 8123. 9.72
#> 8 8 3796. 12188. 7604. 9.82
#> 9 9 6351. 14095. 6786. 11.8
#> 10 10 1667. 11239. 8703. 9.44
#> # … with 18 more rows
```
Another advantage of `areal` is that the interpolation process is not a
“black box”, but rather can be manually completed if necessary.
Functions for validating data, previewing the areal weights, and walking
step-by-step through the interpolation process are provided. See the
[areal weighted interpolation
vignette](https://chris-prener.github.io/areal/articles/areal-weighted-interpolation.html)
for additional details about this workflow.
## Road-map
We are planning to experiment with at least three additional techniques
for areal interpolation for possible inclusion into the package. These
include:
- [Pycnophylactic
method](https://github.com/chris-prener/areal/issues/1) (raster
based, eliminates the sharp transitions in value between target
features)
- [Binary dasymetric
method](https://github.com/chris-prener/areal/issues/2)
(incorporates ancillary data so that population is not assumed to be
evenly distributed within units)
- [3-class regression dasymetric
method](https://github.com/chris-prener/areal/issues/3) (allows for
a more complex estimation based on multiple forms of ancillary data)
We do not have a timeline for these experiments, though we are planning
to begin experimenting with the pycnophylactic method in the coming
months. We will be keeping the issues (linked to above) updated with
progress. If you are interested in bringing these techniques to `R`,
please feel free to contribute to the development of `areal`. The best
place to start is bt checking in on our GitHub issues for each technique
to see what help is needed!
## Contributor Code of Conduct
Please note that this project is released with a [Contributor Code of
Conduct](https://chris-prener.github.io/areal/CODE_OF_CONDUCT.html). By
participating in this project you agree to abide by its terms.
|