Skip to content

Commit

Permalink
update package description
Browse files Browse the repository at this point in the history
  • Loading branch information
polettif committed Feb 23, 2024
1 parent e6e44e8 commit 7af1eff
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Title: Proportional Apportionment
Version: 1.3.1.9000
Authors@R: c(
person("Flavio", "Poletti", role = c("cre", "cph"), email = "[email protected]"))
Description: Calculate seat apportionments for legislative bodies with
various methods. Methods inlcude divisor methods (e.g. D'Hondt, Webster or
Adams), quota methods (e.g. 'largest remainder method') and biproportional
Description: Calculate seat apportionment for legislative bodies with
various methods. These methods include divisor methods (e.g. D'Hondt,
Webster or Adams), largest remainder methods and biproportional
apportionment.
License: GPL (>=3)
Encoding: UTF-8
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# proporz <img src="man/figures/logo.png" align="right" height="138" />

Calculate seat apportionments for legislative bodies with various methods.
Methods inlcude divisor methods (e.g. D'Hondt, Webster or Adams), quota methods
(e.g. largest remainder method) and biproportional apportionment.
Calculate seat apportionment for legislative bodies with various methods. These
methods include divisor methods (e.g. D'Hondt, Webster or Adams), largest
remainder methods and biproportional apportionment.

_Mit diesem R-Package können mittels verschiedener Sitzzuteilungsverfahren
Wählerstimmen in Abgeordnetensitze umgerechnet werden. Das Package beinhaltet
Quoten-, Divisor- und biproportionale Verfahren ("Doppelter Pukelsheim")._

<br/>

## Installation
Install the package from CRAN:

```r
install.packages("proporz")
```
<br/>

## Apportionment methods overview

### Proportional Apportionment
Expand Down Expand Up @@ -45,6 +47,7 @@ proporz(votes, 10, "huntington-hill", quorum = 0.05)
#> 6 4 0
```
<br/>

### Biproportional Apportionment

[Biproportional apportionment](https://en.wikipedia.org/wiki/Biproportional_apportionment)
Expand Down Expand Up @@ -112,10 +115,11 @@ head(seats_df)
#> 6 6 1701 15695 3
```

The [**apportionment scenarios vignette**](https://polettif.github.io/proporz/docs/articles/apportionment_scenarios.html)
The [**apportionment scenarios vignette**](https://polettif.github.io/proporz/articles/apportionment_scenarios.html)
contains more examples.

<br/>

## Shiny app

The package provides a basic Shiny app where you can calculate biproportional
Expand Down Expand Up @@ -170,6 +174,7 @@ divisor_geometric(votes, 10)
```

<br/>

#### Largest remainder method

The largest remainder method is also accessible directly.
Expand All @@ -184,6 +189,7 @@ largest_remainder_method(votes, 20)
```

<br/>

## See also
There are other R packages available that provide apportionment functions, some with
more focus on analysis. However, biproportional apportionment is missing from the
Expand Down

0 comments on commit 7af1eff

Please sign in to comment.