Merge pull request #32 from HRDAG/add-new-functions

Add data objects for data dictionary; closes #18
HRDAG · Oct 23, 2023 · 538d18b · 538d18b
2 parents b5ae3b8 + c0e74c1
commit 538d18b
Show file tree

Hide file tree

Showing 12 changed files with 109 additions and 11 deletions.
diff --git a/R/diccionario_replicas.R b/R/diccionario_replicas.R
@@ -0,0 +1,25 @@
+# ============================================
+# Authors:     MG
+# Maintainers: MG
+# Copyright:   2023, HRDAG, GPL v2 or later
+# ============================================
+
+#' Diccionario de datos para las variables que aparecen en los archivos de las
+#' réplicas. 
+#' 
+#' @docType data
+#' 
+#' @usage data(diccionario_replicas)
+#' @format Un data frame con 55 filas y 4 variables.
+#' \describe{
+#'   \item{nombre_variable}{nombre de la variable}
+#'   \item{tipo}{tipo de la variable: caracter, numérico, lógico}
+#'   \item{detalle_variable}{explicación detallada de la variable}
+#'   \item{categorias_variable}{valores posibles de la variable}
+#' }
+#'
+#' @source Proyecto conjunto JEP-CEV-HRDAG.
+#'
+"diccionario_replicas"
+
+# done.
diff --git a/R/diccionario_vars_adicional.R b/R/diccionario_vars_adicional.R
@@ -0,0 +1,24 @@
+# ============================================
+# Authors:     MG
+# Maintainers: MG
+# Copyright:   2023, HRDAG, GPL v2 or later
+# ============================================
+
+#' Variables adicionales que pueden ser útiles para analizar los datos.
+#' 
+#' @docType data
+#' 
+#' @usage data(diccionario_vars_adicional)
+#' @format Un data frame con 11 filas y 4 variables.
+#' \describe{
+#'   \item{nombre_variable}{nombre de la variable}
+#'   \item{tipo}{tipo de la variable: caracter, numérico, lógico}
+#'   \item{detalle_variable}{explicación detallada de la variable}
+#'   \item{categorias_variable}{valores posibles de la variable}
+#' }
+#'
+#' @source Proyecto conjunto JEP-CEV-HRDAG.
+#'
+"diccionario_vars_adicional"
+
+# done.
diff --git a/R/estratificacion.R b/R/estratificacion.R
@@ -11,15 +11,15 @@
 #' @docType data
 #' 
 #' @usage data(estratificacion)
-#' @format Un data frame con 31 filas y 4 variables
+#' @format Un data frame con 31 filas y 4 variables.
 #' \describe{
 #'   \item{violacion}{el hecho de violencia al analizar}
 #'   \item{estimacion}{el tipo de análisis que utiliza la estratificación (p.ej., patrones de violencia por año, sexo, etc.)}
 #'   \item{estratificacion}{las variables utilizadas para estratificar las estimaciones}
 #'   \item{notas}{notas adicionales sobre la estratificación; NA si no hay notas}
 #' }
 #'
-#' @source proyecto conjunto JEP-CEV-HRDAG
+#' @source Proyecto conjunto JEP-CEV-HRDAG.
 #'
 "estratificacion"
 

diff --git a/R/stratification.R b/R/stratification.R
@@ -11,15 +11,15 @@
 #' @docType data
 #'
 #' @usage  data(stratification)
-#' @format A data frame with 31 rows and 4 variables
+#' @format A data frame with 31 rows and 4 variables.
 #' \describe{
 #'   \item{violation}{the human rights violation being analyzed}
 #'   \item{estimation}{the type of analysis the stratification was used for (e.g., patterns of violence by year, sex, etc.)}
 #'   \item{stratification}{the variables used to stratify the estimates}
 #'   \item{notes}{additional notes about the stratification; NA if no notes}
 #' }
 #'
-#' @source joint JEP-CEV-HRDAG project
+#' @source Joint JEP-CEV-HRDAG project.
 #'
 "stratification"
 

diff --git a/data/diccionario_replicas.rda b/data/diccionario_replicas.rda
diff --git a/data/diccionario_vars_adicional.rda b/data/diccionario_vars_adicional.rda
diff --git a/inst/docs/diccionario-variables-replicas.xlsx b/inst/docs/diccionario-variables-replicas.xlsx
diff --git a/man/diccionario_replicas.Rd b/man/diccionario_replicas.Rd
diff --git a/man/diccionario_vars_adicional.Rd b/man/diccionario_vars_adicional.Rd
diff --git a/man/estratificacion.Rd b/man/estratificacion.Rd
diff --git a/man/stratification.Rd b/man/stratification.Rd
diff --git a/tests/testthat/test-estimate_mse.R b/tests/testthat/test-estimate_mse.R
@@ -131,15 +131,12 @@ testthat::test_that("mse function returns correct results when using lookup func
 
     # there are warnings here because our toy estimates directory does not contain
     # the same number of files as the real estimates directory would
-    s4_start <- Sys.time()
     r4 <- mse(stratum_data = stratum_4,
               stratum_name = "stratum 4",
               estimates_dir = estimates_dir)
-    s4_end <- Sys.time()
 
     testthat::expect_equal(nrow(r4), 1000)
     testthat::expect_named(r4, c("validated", "N", "valid_sources", "n_obs", "stratum_name"))
-    testthat::expect_true(as.numeric(s4_end - s4_start) > 5) # needs to estimate, should take more time
 
 })