R/data_example.R

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

#' Example of total vote count vector
#' 
#' @description
#' This is an example of a total vote count vector for 5 
#' parties/candidates that can be used to illustrate different seat 
#' allocation formulas.
#' @format A vector of integers representing the total votes received by
#' each party/candidate.
#' \describe{
#' \item{A}{Votes received by party A}
#' \item{B}{Votes received by party B}
#' ...
#' }
#' @source This is a synthetic example created for demonstration purposes.
"example"