Modifications, examples and tests to submit to CRAN

rOpenSpain · Mar 8, 2024 · d5d85bc · d5d85bc
1 parent 69f9248
commit d5d85bc
Show file tree

Hide file tree

Showing 26 changed files with 406 additions and 190 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,15 +2,25 @@ Package: infoelectoral
 Type: Package
 Title: Download Spanish Election Results
 Version: 1.0.0
-Author: Héctor Meleiro
+Authors@R: 
+    person("Héctor", "Meleiro", 
+    email = "[email protected]", 
+    role = c("aut", "cre"))
 Maintainer: Héctor Meleiro <[email protected]>
-Description: Download official election results for Spain at polling station, municipality and province level from the Ministry of Interior, format them and import them to the R environment.
+Description: Download official election results for Spain at polling station, municipality and province level from the Ministry of Interior (<https://infoelectoral.interior.gob.es/es/elecciones-celebradas/area-de-descargas/>), format them and import them to the R environment.
 Depends: R (>= 3.5.0)
 License: GPL-2
 URL: https://github.com/rOpenSpain/infoelectoral
 Encoding: UTF-8
 LazyData: true
-Imports: rlang (>= 0.4.0), dplyr (>= 1.0.0), stringr (>= 1.0.0)
-Suggests: mapSpain, tmap, tidyr, preferably, knitr
+Imports: dplyr (>= 1.0.0), stringr (>= 1.0.0)
+Suggests: 
+    mapSpain,
+    tmap,
+    tidyr,
+    preferably,
+    knitr,
+    testthat (>= 3.0.0)
 RoxygenNote: 7.2.3
 VignetteBuilder: knitr
+Config/testthat/edition: 3
diff --git a/NAMESPACE b/NAMESPACE
@@ -7,15 +7,14 @@ export(provincias)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,arrange)
 importFrom(dplyr,bind_rows)
+importFrom(dplyr,desc)
 importFrom(dplyr,full_join)
 importFrom(dplyr,left_join)
 importFrom(dplyr,mutate)
 importFrom(dplyr,mutate_if)
 importFrom(dplyr,relocate)
 importFrom(dplyr,select)
-importFrom(rlang,.data)
 importFrom(stringr,str_remove_all)
 importFrom(stringr,str_trim)
-importFrom(utils,data)
 importFrom(utils,download.file)
 importFrom(utils,unzip)
diff --git a/R/candidatos.R b/R/candidatos.R
@@ -7,6 +7,8 @@
 #' @param mes The month of the election in MM format.
 #' @param nivel The administrative level for which the data is wanted ("mesa" for polling stations or "municipio" for municipalities). Only necessary when tipo_eleccion = "senado"
 #'
+#' @example R/examples/candidatos.R
+#'
 #' @return data.frame with the candidates data. If tipo_eleccion = "senado" a column called  `votos` is included with the votes recieved by each candidate. If other type of election is selected this column is not included since the votes are not received by the specific candidates but by the closed list of the party.
 #'
 #' @importFrom stringr str_trim

diff --git a/R/candidatos_nosenado.R b/R/candidatos_nosenado.R
@@ -57,32 +57,34 @@ candidatos_nosenado <- function(tipo, anno, mes) {
 
   df <- df %>%
     mutate_if(is.character, str_trim) %>%
-    mutate(denominacion = str_remove_all(.data$denominacion, '"')) %>%
+    mutate(denominacion = str_remove_all("denominacion", '"')) %>%
     select(
-      .data$tipo_eleccion,
-      .data$anno,
-      .data$mes,
-      .data$vuelta,
-      .data$codigo_provincia,
-      .data$codigo_municipio,
-      .data$codigo_distrito,
-      .data$orden_candidato,
-      .data$tipo_candidato,
-      .data$nombre,
-      .data$apellido_1,
-      .data$apellido_2,
-      .data$sexo,
-      .data$nacimiento,
-      .data$dni ,
-      .data$electo,
-      .data$codigo_partido_nacional,
-      .data$codigo_partido_autonomia,
-      .data$codigo_partido_provincia,
-      .data$codigo_partido,
-      .data$denominacion,
-      .data$siglas
-    )%>%
-    arrange(.data$codigo_provincia, .data$siglas, .data$orden_candidato)
+      "tipo_eleccion",
+      "anno",
+      "mes",
+      "vuelta",
+      "codigo_provincia",
+      "codigo_municipio",
+      "codigo_distrito",
+      "orden_candidato",
+      "tipo_candidato",
+      "nombre",
+      "apellido_1",
+      "apellido_2",
+      "sexo",
+      "nacimiento",
+      "dni" ,
+      "electo",
+      "codigo_partido_nacional",
+      "codigo_partido_autonomia",
+      "codigo_partido_provincia",
+      "codigo_partido",
+      "denominacion",
+      "siglas"
+    ) %>%
+    arrange("codigo_provincia", "siglas", "orden_candidato")
+
+  df <- df[!is.na(df$orden_candidato),]
 
   df$nacimiento <- NA
   df$dni <- NA

diff --git a/R/data.R b/R/data.R
@@ -52,6 +52,20 @@
 #' }
 "codigos_partidos"
 
+#' Election dates
+#'
+#' This dataset contains the dates of the local, general and european elections in Spain from 1977 to 2023.
+#'
+#' @format A dataset with the dates of the elections
+#' \describe{
+#'   \item{tipo_eleccion}{Election level (local, general or european parliament)}
+#'   \item{anno}{Year of the election}
+#'   \item{mes}{Month of the election}
+#'   \item{day}{Day of the election}
+#' }
+#' @source \url{https://www.juntaelectoralcentral.es/cs/jec/elecciones}
+"fechas_elecciones"
+
 #' Mean income at the census section level (INE)
 #'
 #' This dataset contains the mean income of each census section

diff --git a/R/examples/candidatos.R b/R/examples/candidatos.R
@@ -0,0 +1,5 @@
+\dontrun{
+  data <- candidatos(tipo_eleccion = "senado", anno = "2004",
+                     mes = "03", nivel = "municipio")
+  str(data)
+}
diff --git a/R/examples/mesas.R b/R/examples/mesas.R
@@ -0,0 +1,4 @@
+\dontrun{
+  data <- mesas(tipo_eleccion = "congreso", anno = "2023", mes = "07")
+  str(data)
+}
diff --git a/R/examples/municipios.R b/R/examples/municipios.R
@@ -0,0 +1,4 @@
+\dontrun{
+  data <- municipios(tipo_eleccion = "congreso", anno = "2019", mes = "11")
+  str(data)
+}
diff --git a/R/examples/provincias.R b/R/examples/provincias.R
@@ -0,0 +1,4 @@
+\dontrun{
+  data <- provincias(tipo_eleccion = "congreso", anno = "1982", mes = "10")
+  str(data)
+}
diff --git a/R/mesas.R b/R/mesas.R
@@ -6,15 +6,17 @@
 #' @param anno The year of the election in YYYY format.
 #' @param mes The month of the election in MM format.
 #'
+#' @example R/examples/mesas.R
+#'
 #' @return data.frame with the electoral results data at the polling station level.
 #'
 #' @importFrom stringr str_trim
 #' @importFrom stringr str_remove_all
 #' @importFrom dplyr relocate
+#' @importFrom dplyr desc
 #' @importFrom dplyr full_join
 #' @importFrom dplyr left_join
 #' @importFrom dplyr %>%
-#' @importFrom rlang .data
 #'
 #' @export
 mesas <- function(tipo_eleccion, anno, mes) {
@@ -70,32 +72,32 @@ mesas <- function(tipo_eleccion, anno, mes) {
   codigos_municipios <- infoelectoral::codigos_municipios
   df <- left_join(df, codigos_municipios, by = c("codigo_provincia", "codigo_municipio")) %>%
     relocate(
-      .data$codigo_ccaa,
-      .data$codigo_provincia,
-      .data$codigo_municipio,
-      .data$municipio,
-      .data$codigo_distrito,
-      .data$codigo_seccion,
-      .data$codigo_mesa,
-      .after = .data$vuelta) %>%
+      "codigo_ccaa",
+      "codigo_provincia",
+      "codigo_municipio",
+      "municipio",
+      "codigo_distrito",
+      "codigo_seccion",
+      "codigo_mesa",
+      .after = "vuelta") %>%
     relocate(
-      .data$codigo_partido_autonomia,
-      .data$codigo_partido_provincia,
-      .data$codigo_partido,
-      .data$denominacion,
-      .data$siglas,
-      .data$votos,
-      .data$datos_oficiales ,
-      .after = .data$codigo_partido_nacional
+      "codigo_partido_autonomia",
+      "codigo_partido_provincia",
+      "codigo_partido",
+      "denominacion",
+      "siglas",
+      "votos",
+      "datos_oficiales" ,
+      .after = "codigo_partido_nacional"
     ) %>%
     arrange(
-      .data$codigo_ccaa,
-      .data$codigo_provincia,
-      .data$codigo_municipio,
-      .data$codigo_distrito,
-      .data$codigo_seccion,
-      .data$codigo_mesa,
-      -.data$votos
+      "codigo_ccaa",
+      "codigo_provincia",
+      "codigo_municipio",
+      "codigo_distrito",
+      "codigo_seccion",
+      "codigo_mesa",
+      desc("votos")
     )
 
   df$municipio[df$codigo_municipio == "999"] <- "CERA"

diff --git a/R/muni.R b/R/muni.R
@@ -7,6 +7,8 @@
 #' @param mes The month of the election in MM format.
 #' @param distritos Should district level results be returned when available? The default is FALSE. Please be aware when summarizing the data that districts = TRUE will return separate rows for the total municipal level and for each of the districts.
 #'
+#' @example R/examples/municipios.R
+#'
 #' @return Dataframe with the electoral results data at the municipality level.
 #'
 #' @importFrom stringr str_trim
@@ -16,8 +18,6 @@
 #' @importFrom dplyr bind_rows
 #' @importFrom dplyr full_join
 #' @importFrom dplyr left_join
-#' @importFrom rlang .data
-#' @importFrom utils data
 #' @export
 #'
 municipios <- function(tipo_eleccion, anno, mes, distritos = FALSE) {
@@ -94,26 +94,26 @@ municipios <- function(tipo_eleccion, anno, mes, distritos = FALSE) {
   df <- left_join(df, codigos_municipios,
                   by = c("codigo_provincia", "codigo_municipio")) %>%
     relocate(
-      .data$codigo_ccaa,
-      .data$codigo_provincia,
-      .data$codigo_municipio,
-      .data$municipio,
-      .data$codigo_distrito,
-      .data$codigo_distrito_electoral,
-      .data$codigo_partido_judicial,
-      .data$codigo_diputacion,
-      .data$codigo_comarca,
-      .after = .data$vuelta) %>%
+      "codigo_ccaa",
+      "codigo_provincia",
+      "codigo_municipio",
+      "municipio",
+      "codigo_distrito",
+      "codigo_distrito_electoral",
+      "codigo_partido_judicial",
+      "codigo_diputacion",
+      "codigo_comarca",
+      .after = "vuelta") %>%
     relocate(
-      .data$codigo_partido_autonomia,
-      .data$codigo_partido_provincia,
-      .data$codigo_partido,
-      .data$denominacion,
-      .data$siglas,
-      .data$votos,
-      .data$datos_oficiales ,
-      .data$concejales_obtenidos,
-      .after = .data$codigo_partido_nacional
+      "codigo_partido_autonomia",
+      "codigo_partido_provincia",
+      "codigo_partido",
+      "denominacion",
+      "siglas",
+      "votos",
+      "datos_oficiales",
+      "concejales_obtenidos",
+      .after = "codigo_partido_nacional"
     )
 
   ### Si no se quieren los distritos se eliminan de los datos

diff --git a/R/provincias.R b/R/provincias.R
@@ -6,15 +6,17 @@
 #' @param anno The year of the election in YYYY format.
 #' @param mes The month of the election in MM format.
 #'
+#' @example R/examples/provincias.R
+#'
 #' @return data.frame with the electoral results data at the polling station level.
 #'
 #' @importFrom stringr str_trim
 #' @importFrom stringr str_remove_all
 #' @importFrom dplyr relocate
+#' @importFrom dplyr desc
 #' @importFrom dplyr full_join
 #' @importFrom dplyr left_join
 #' @importFrom dplyr %>%
-#' @importFrom rlang .data
 #'
 #' @export
 provincias <- function(tipo_eleccion, anno, mes) {
@@ -78,30 +80,30 @@ provincias <- function(tipo_eleccion, anno, mes) {
   # Inserto el nombre del municipio más reciente y reordeno algunas variables
   df <- df %>%
     relocate(
-      .data$codigo_ccaa,
-      .data$codigo_provincia,
-      .data$codigo_distrito_electoral,
-      .after = .data$vuelta) %>%
+      "codigo_ccaa",
+      "codigo_provincia",
+      "codigo_distrito_electoral",
+      .after = "vuelta") %>%
     relocate(
-      .data$codigo_partido_autonomia,
-      .data$codigo_partido_provincia,
-      .data$codigo_partido,
-      .data$denominacion,
-      .data$siglas,
-      .data$votos,
-      .data$diputados,
-      .data$datos_oficiales,
-      .after = .data$codigo_partido_nacional
+      "codigo_partido_autonomia",
+      "codigo_partido_provincia",
+      "codigo_partido",
+      "denominacion",
+      "siglas",
+      "votos",
+      "diputados",
+      "datos_oficiales",
+      .after = "codigo_partido_nacional"
     ) %>%
     relocate(
-      .data$n_diputados,
-      .after = .data$poblacion_derecho
+      "n_diputados",
+      .after = "poblacion_derecho"
     ) %>%
     arrange(
-      .data$codigo_ccaa,
-      .data$codigo_provincia,
-      .data$codigo_distrito_electoral,
-      -.data$votos
+      "codigo_ccaa",
+      "codigo_provincia",
+      "codigo_distrito_electoral",
+      desc("votos")
     )
 
   return(df)