From 7af1eff0796a985ad9d2e870e36b26ef0078aac5 Mon Sep 17 00:00:00 2001 From: Flavio Poletti Date: Fri, 23 Feb 2024 13:09:47 +0100 Subject: [PATCH] update package description --- DESCRIPTION | 6 +++--- README.md | 14 ++++++++++---- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index aa3d8f4..b1cc641 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -4,9 +4,9 @@ Title: Proportional Apportionment Version: 1.3.1.9000 Authors@R: c( person("Flavio", "Poletti", role = c("cre", "cph"), email = "flavio.poletti@hotmail.ch")) -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 diff --git a/README.md b/README.md index 8b7f156..592fa13 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # proporz -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")._
+ ## Installation Install the package from CRAN: @@ -16,6 +17,7 @@ Install the package from CRAN: install.packages("proporz") ```
+ ## Apportionment methods overview ### Proportional Apportionment @@ -45,6 +47,7 @@ proporz(votes, 10, "huntington-hill", quorum = 0.05) #> 6 4 0 ```
+ ### Biproportional Apportionment [Biproportional apportionment](https://en.wikipedia.org/wiki/Biproportional_apportionment) @@ -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.
+ ## Shiny app The package provides a basic Shiny app where you can calculate biproportional @@ -170,6 +174,7 @@ divisor_geometric(votes, 10) ```
+ #### Largest remainder method The largest remainder method is also accessible directly. @@ -184,6 +189,7 @@ largest_remainder_method(votes, 20) ```
+ ## 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