-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
46 lines (31 loc) · 1.56 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = '#>',
fig.path = 'man/figures/README-',
out.width = '100%'
)
```
# redistio <a href="http://www.christophertkenny.com/redistio/"><img src="man/figures/logo.png" align="right" height="114" alt="redistio website" /></a>
<!-- badges: start -->
[![r-universe status badge](https://christopherkenny.r-universe.dev/badges/redistio)](https://christopherkenny.r-universe.dev/ui#package:redistio)
[![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/christopherkenny/redistio/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/christopherkenny/redistio/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
`redistio` provides a point-and-click districting interface powered by [Shiny](https://shiny.posit.co/) and [Leaflet](https://leafletjs.com/). For regular `sf` objects, it can be used to draw districts and export assignment files. For `redist_map` objects, algorithmic assistance is enabled for map drawing.
## Installation
You can install the development version of `redistio` from [GitHub](https://github.com/) with:
``` r
pak::pkg_install('christopherkenny/redistio')
```
## Example
The most basic application of `redistio` starts with an `sf` tibble and a column of district assignments.
```r
library(redistio)
draw(dc, dc$ward)
```
![](man/figures/example_interactive.png)