R/LireMinInterieur.R

In joelgombin/LireMinInterieur: Ce package offre des outils pour nettoyer les fichiers électoraux du ministère de l'intérieur.

#' Fonction pour transformer les fichiers du ministère de l'intérieur en data.frame utilisable
#' 
#' La fonction \code{lire} est utile pour transformer les fichiers de résultats électoraux diffusés par le ministère de l'Intérieur français, lorsque l'offre électorale n'est pas homogène sur l'ensemble du territoire (législatives, européennes, cantonales, régionales...). Pour ce faire, les résultats sont agrégés en fonction des étiquettes attribuées par le ministère de l'intérieur. 
#' 
#'  @param X un data.frame brut. Généralement importé depuis un CSV.
#'  @param keep vecteur indiquant le numéro (ou le nom) des colonnes à conserver telles quelles (habituellement Inscrits, Exprimés, Blancs, Nuls, etc.). Il doit impérativement y avoir les Inscrits et les Exprimés.
#'  @param col vecteur indiquant le numéro des colonnes contenant les étiquettes à partir desquelles les résultats sont agrégés. Généralement, leur espacement est régulier, donc peut s'écrire sous la forme de, e.g., \code{seq(10, 100, 10)}.
#'  @param keep.names le nom à donner aux colonnes conservées en l'état (paramètre \code{keep}). Par défaut, le nom de ces colonnes dans le \code{data.frame X}. Il est nécessaire qu'il y ait une colonne intitulée "Inscrits" et une colonne intitulée "Exprimés". 
#'  @param gap décalage entre les colonnes avec les étiquettes et les colonnes avec le nombre de voix. Par défaut, 3.
#'  
#'  @return un \code{data.frame} avec les colonnes conservées ainsi que, pour chaque nuance politique, une colonne avec le total des voix, une colonne avec le score rapporté aux inscrits, une colonne avec le score rapporté aux exprimés. Enfin, pour chaque nuance, une colonne indique le nombre de candidats (ou de listes) qu'il y avait dans la circonscription territoriale.
#'  @export
#'  @import compiler
#'  @importFrom dplyr %>%
#'  @examples
#'  data(Eur2014Dpts)
#'  names(Eur2014Dpts)
#'  res <- lire(Eur2014Dpts, keep = c(2,4,5,7,9,12,15), col=c(seq(19,229,7)), keep.names=c("CodeDpt", "Inscrits", "Abstentions","Votants", "Blancs", "Nuls", "Exprimés"))

lire <- function(X, keep, col, keep.names = names(res1), gap=3) {
  # on s'assure qu'il n'y a pas de factors qui traînent mais que des characters
  X <- X %>% 
    dplyr::mutate(dplyr::across(tidyselect:::where(is.factor), as.character))
  # on crée un df dans lequel on va stocker les résultats
  res1 <- X[,keep]
  names(res1) <- keep.names
  
  # on récupère l'ensemble des nunances possibles
  nuances <- unique(unlist(X[,col]))[!seq_along(unique(unlist(X[,col]))) %in% match("",unique(unlist(X[,col])))]
  nuances <- na.omit(nuances)
  
  etiquettes <- as.matrix(X[,col])
  valeurs <- as.matrix(X[,col + gap])
  
  candidats <- paste("NbCand", nuances, sep="")
  res2 <- matrix(0, nrow=dim(res1)[1], ncol=length(nuances) + length(candidats), dimnames=list(c(), c(nuances, candidats)), byrow=TRUE)
  
  
  
  for (i in 1:length(nuances)) {
    for (j in 1:dim(etiquettes)[1]) {
      index <- which(etiquettes[j,] == nuances[i])
      res2[j,nuances[i]] <- sum(valeurs[j, index], na.rm = TRUE)
      res2[j,candidats[i]] <- sum(length(index), na.rm = TRUE)
    }
  }  
  
  res <- cbind(res1, res2)
  res[,paste(nuances, ".ins", sep="")] <- res[,nuances]/res[,"Inscrits"]*100
  res[,paste(nuances, ".exp", sep="")] <- res[,nuances]/res[,"Exprimés"]*100
  return(res)
}



#' Résultats des élections européennes de 2014, par département
#' 
#' @details Un jeu de données contenant les résultats des élections européennes de 2014, par département. Les données ont été téléchargées sur \url{http://www.data.gouv.fr/fr/dataset/elections-europeennes-2014-resulta-1}, puis la feuille consacrée aux départements a été sauvegardée en csv (en enlevant simplement les deux premières lignes, pour que les titres de colonnes soient sur la première ligne). Elle a ensuite été importée dans R avec le code suivant : \code{Eur2014Dpts <- read.csv("./Eur2014Dpts.csv", header=TRUE, sep=";", stringsAsFactor=FALSE)}.
#' 
#' @docType data
#' @keywords dataset
#' @format un jeu de données de 107 lignes et 234 variables
#' @name Eur2014Dpts
#' @source \url{http://www.data.gouv.fr/fr/dataset/elections-europeennes-2014-resulta-1}
NULL 


#' Version interactive de la fonction \code{lire}
#' 
#' Cette fonction lance une application shiny qui permet d'utiliser de manière interactive la fonction \code{lire}.
#' 
#' @export
#' @import shiny

lireInteractif <- function() {
  runApp(system.file("liremininterieur", package="LireMinInterieur"))
}