Skip to content

Commit

Permalink
update citation style and links
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherkenny committed Nov 30, 2023
1 parent 713737a commit 53f529a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ knitr::opts_chunk$set(
)
```

# redistmetrics <a href="https://alarm-redist.github.io/redistmetrics/"><img src="man/figures/logo.png" align="right" height="132" /></a>
# redistmetrics <a href="https://alarm-redist.org/redistmetrics/"><img src="man/figures/logo.png" align="right" height="132" /></a>

<!-- badges: start -->
[![R-CMD-check](https://github.com/alarm-redist/redistmetrics/workflows/R-CMD-check/badge.svg)](https://github.com/alarm-redist/redistmetrics/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/redistmetrics)](https://CRAN.R-project.org/package=redistmetrics)
![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/redistmetrics)
<!-- badges: end -->

`redistmetrics` is one of the R packages developed and maintained by the [ALARM Project](https://alarm-redist.github.io/). `redistmetrics` provides the back-end for the computation of summary statistics for a redistricting plan. It provides a more direct access point to use methods in `redist` without requiring `redist` objects.
`redistmetrics` is one of the R packages developed and maintained by the [ALARM Project](https://alarm-redist.org/). `redistmetrics` provides the back-end for the computation of summary statistics for a redistricting plan. It provides a more direct access point to use methods in `redist` without requiring `redist` objects.

## Installation

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# redistmetrics <a href="https://alarm-redist.github.io/redistmetrics/"><img src="man/figures/logo.png" align="right" height="132" /></a>
# redistmetrics <a href="https://alarm-redist.org/redistmetrics/"><img src="man/figures/logo.png" align="right" height="132" /></a>

<!-- badges: start -->

Expand All @@ -13,7 +13,7 @@ downloads](http://cranlogs.r-pkg.org/badges/grand-total/redistmetrics)
<!-- badges: end -->

`redistmetrics` is one of the R packages developed and maintained by the
[ALARM Project](https://alarm-redist.github.io/). `redistmetrics`
[ALARM Project](https://alarm-redist.org/). `redistmetrics`
provides the back-end for the computation of summary statistics for a
redistricting plan. It provides a more direct access point to use
methods in `redist` without requiring `redist` objects.
Expand Down
24 changes: 13 additions & 11 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
citHeader("To cite redistmetrics in publications use:")

citEntry(entry = "misc",
title = "{redistmetrics}: Redistricting Metrics",
author = personList(as.person("Christopher T. Kenny"), as.person("Cory McCartan"), as.person("Ben Fifield"),
as.person("Kosuke Imai")),
howpublished = "Available at The Comprehensive R Archive Network (CRAN)",
year = "2021",
url = "https://github.com/alarm-redist/redistmetrics",
textVersion = paste(" Christopher T. Kenny, Cory McCartan, Ben Fifield, and Kosuke Imai (2021).",
"redistmetrics: Redistricting Metrics.",
"Available at The Comprehensive R Archive Network (CRAN).",
"URL https://github.com/alarm-redist/redistmetrics.")
bibentry(
bibtype = "Manual",
title = "{redistmetrics}: Redistricting Metrics",
author = c(
person("Christopher T.", "Kenny", email = "[email protected]", role = c("aut", "cre")),
person("Cory", "McCartan", email = "[email protected]", role = "aut"),
person("Ben", "Fifield", email = "[email protected]", role = "aut"),
person("Kosuke", "Imai", email = "[email protected]", role = "aut")
),
year = "2023",
note = "R package",
key = "redistmetrics",
url = "https://alarm-redist.org/redistmetrics/"
)
4 changes: 2 additions & 2 deletions vignettes/redistmetrics.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ knitr::opts_chunk$set(

`redistmetrics` provides an interface for computing common redistricting measures and metrics. This covers the range of compactness measures, partisan gerrymandering metrics, county splits, and more. The goal is to provide a flexible and friendly (to existing R users) implementation of scores which are often used in academic research, litigation, public projects, and journalism. This package began as a set of functions in [`redist`](https://CRAN.R-project.org/package=redist). While those features will remain, this package should offer friendlier examples by separating out measures into their own functions.

The package is developed and maintained by the [ALARM Project](https://alarm-redist.github.io), the ALgorithm-Assisted Redistricting Methodology Project,a research project under the direction of Kosuke Imai. The code in this package was developed by Christopher T. Kenny, Cory McCartan, and Ben Fifield. When using the package, please cite the package using the following:
The package is developed and maintained by the [ALARM Project](https://alarm-redist.org), the ALgorithm-Assisted Redistricting Methodology Project,a research project under the direction of Kosuke Imai. The code in this package was developed by Christopher T. Kenny, Cory McCartan, and Ben Fifield. When using the package, please cite the package using the following:

```{r}
citation('redistmetrics')
Expand Down Expand Up @@ -96,4 +96,4 @@ part_egap(plans = nh$r_2020, shp = nh,
by_plan()
```

For more information, view the other vignettes or the [package website](https://alarm-redist.github.io/redistmetrics/index.html).
For more information, view the other vignettes or the [package website](https://alarm-redist.org/redistmetrics/index.html).

0 comments on commit 53f529a

Please sign in to comment.