| Title: | Dot Density Maps |
| Version: | 0.0.2 |
| Description: | Generate point data for representing people within spatial data. This collects a suite of tools for creating simple dot density maps. Several functions from different spatial packages are standardized to take the same arguments so that they can be easily substituted for each other. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| LazyData: | true |
| RoxygenNote: | 7.2.0 |
| Imports: | ggplot2, magrittr, rlang, rmapshaper, sf, terra, purrr, dplyr, sp |
| URL: | https://github.com/christopherkenny/dots, http://christophertkenny.com/dots/ |
| BugReports: | https://github.com/christopherkenny/dots/issues |
| Depends: | R (≥ 4.1) |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.0.0), wacolors |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2022-07-11 16:33:36 UTC; chris |
| Author: | Christopher T. Kenny
 [aut, cre] |
| Maintainer: | Christopher T. Kenny <christopherkenny@fas.harvard.edu> |
| Repository: | CRAN |
| Date/Publication: | 2022-07-15 08:40:07 UTC |
Pipe operator
Description
See magrittr::%>% for details.
Usage
lhs %>% rhs
Arguments
lhs |
A value or the magrittr placeholder. |
rhs |
A function call using the magrittr semantics. |
Value
The result of calling rhs(lhs).
Boston Water
Description
This data contains the largest named water within Suffolk County MA, with geographies simplified.
Usage
data("boston_water")
Format
An sf dataframe with 10 observations
Examples
data('boston_water')
Remove Water
Description
Remove Water
Usage
clip_water(shp, water, filter_islands = FALSE, ...)
Arguments
shp |
input shp with |
water |
water shapes to remove with |
filter_islands |
logical. Should additional filtering be done to remove small areas? |
... |
additional arguments to pass to |
Value
tibble with sf geometries
Examples
# time to run varies greatly, depending on machine
data(suffolk)
data(boston_water)
clip_water(suffolk, boston_water[10, ])
Make dot density plots
Description
Make dot density plots
Usage
dots(
shp,
cols,
engine = engine_terra,
divisor = 250,
min_point = 0.1 * divisor
)
Arguments
shp |
input shp with |
cols |
< |
engine |
backend to use. Default is |
divisor |
Number of people per dot. Default is 250. |
min_point |
Minimum number of people to generate one dot. Defaults to 10% of the divisor. |
Value
A ggplot
Examples
data('suffolk')
# subset to first 20 rows for speed on CRAN
dots(suffolk[1:20, ], c(vap_black), divisor = 2000)
Make dot density points
Description
Make dot density points
Usage
dots_points(
shp,
cols,
engine = engine_terra,
divisor = 250,
min_point = 0.1 * divisor
)
Arguments
shp |
input shp with |
cols |
< |
engine |
backend to use. Default is |
divisor |
Number of people per dot. Default is 250. |
min_point |
Minimum number of people to generate one dot. Defaults to 10% of the divisor. |
Value
tibble with sf geometries
Examples
data('suffolk')
# subset to first 20 rows for speed on CRAN
dots_points(suffolk[1:20, ], c(vap_black))
Generate Hexagonal Points with sf
Description
Uses sf::st_sample() to produce points and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sf_hexagonal(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sf_hexagonal(suffolk[16:20,], 'pop_nhpi')
Generate Random Points with sf
Description
Uses sf::st_sample() to produce points and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Usage
engine_sf_random(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sf_random(suffolk[16:20,], 'pop_nhpi')
Generate Regular Points with sf
Description
Uses sf::st_sample() to produce points and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sf_regular(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sf_regular(suffolk[16:20,], 'pop_nhpi')
Generate Clustered Points with sp
Description
Uses sp::spsample() with method "clustered" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_clustered(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_clustered(suffolk[16:20, ], 'pop_nhpi')
Generate Hexagonal Points with sp
Description
Uses sp::spsample() with method "hexagonal" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_hexagonal(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_hexagonal(suffolk[16:20, ], 'pop_nhpi')
Generate Nonaligned Points with sp
Description
Uses sp::spsample() with method "nonaligned" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_nonaligned(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_nonaligned(suffolk[16:20, ], 'pop_nhpi')
Generate Random Points with sp
Description
Uses sp::spsample() with method "random" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_random(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_random(suffolk[16:20,], 'pop_nhpi')
Generate Regular Points with sp
Description
Uses sp::spsample() with method "regular" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_regular(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_regular(suffolk[16:20,], 'pop_nhpi')
Generate Stratified Points with sp
Description
Uses sp::spsample() with method "regular" to produce points, converts back to sf,
and spatial joins with input shp.
Each engine function takes the same arguments and produces comparable outputs.
Final number of points may be approximate for this method.
Usage
engine_sp_stratified(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_sp_stratified(suffolk[16:20, ], 'pop_nhpi')
Generate Points with terra
Description
Uses terra::dots() to produce points and transforms back to sf.
Each engine function takes the same arguments and produces comparable outputs.
Usage
engine_terra(shp, col)
Arguments
shp |
input shp with |
col |
character column name to produce points with |
Value
tibble with sf geometries
Examples
set.seed(1)
data('suffolk')
engine_terra(suffolk, 'pop_nhpi')
Filter Points to a Region
Description
Filter Points to a Region
Usage
filter_pts(pts, shp, cond = TRUE)
Arguments
pts |
points with |
shp |
shp to filter to |
cond |
geometry subset to reduce shp to |
Value
tibble with sf geometries
Examples
data(suffolk)
pts <- dots_points(suffolk, pop, divisor = 1000)
filter_pts(pts, suffolk, pop < 1000)
Suffolk County, MA Voting Districts
Description
This data contains the voting districts for Suffolk County MA, with geographies simplified.
Usage
data("suffolk")
Format
An sf dataframe with 295 observations
Examples
data('suffolk')