R/data_ranked.R

In i3pack: Incentives for Inter- And Intra-Party Electoral Competition

#' Example of ranked vote matrix
#'
#' @description
#' This is an example of a ranked vote matrix for 4 voters and
#' 3 candidates. It can be used to illustrate different seat allocation formulas
#' that require ranked votes. 
#' 
#' @format A matrix with 3 rows and 4 columns, where each row represents a ranking,
#' each column is a voter, and each cell is the candidate ID (numeric or character)
#' #' that the voter ranked in that position. 
#' \describe{
#' \item{Voter1}{Candidates ranked first, second, and third by the first voter}
#' \item{Voter2}{Candidates ranked first, second, and third by the second voter}
#' ...
#' }
#' @source Created by the package authors for demonstration purposes. 
"ranked"