documentation

ropensci · Sep 11, 2023 · b7a0bfa · b7a0bfa
1 parent 99b775c
commit b7a0bfa
Show file tree

Hide file tree

Showing 40 changed files with 5,420 additions and 1,493 deletions.
diff --git a/Meta/vignette.rds b/Meta/vignette.rds
diff --git a/R/adulto_equivalente.R b/R/adulto_equivalente.R
@@ -10,7 +10,7 @@
 #' }
 #'
 #' @details
-#' De acuerdo con la metodologia de INDEC (https://www.indec.gob.ar/ftp/cuadros/sociedad/preguntas_frecuentes_cba_cbt.pdf):
+#' De acuerdo con la metodologia de [INDEC](https://www.indec.gob.ar/ftp/cuadros/sociedad/preguntas_frecuentes_cba_cbt.pdf):
 #'
 #' "Para identificar la unidad consumidora de referencia, o adulto equivalente, se analizo en que grupo de edad se ubicaba la mayor concentracion de poblacion activa, y fue la categoria de hombres de 30 a 60 anios de edad la que presentaba el mayor peso relativo dentro del conjunto total de la poblacion de referencia. Por este motivo se considero como adulto equivalente al hombre de 30 a 60 anios con un estilo de vida moderadamente activo y no otro grupo poblacional."
 #'

diff --git a/R/eph.R b/R/eph.R
@@ -7,6 +7,7 @@
 #'
 #' @docType package
 #' @name eph
+#' @aliases eph-package
 #'
 #' @noRd
 NULL

diff --git a/R/organize_cno.R b/R/organize_cno.R
@@ -4,7 +4,7 @@
 #' (CNO 2001)
 #' @param base Base individual de uno o mas periodos
 #'
-#' @return Devuelve la base con 4 columnas nuevas (ver `CNO`)
+#' @return Devuelve la base con 4 columnas nuevas (que indican la informacion correspondiente al Clasificador Nacional de Ocupaciones)
 #'
 #' @details
 #' Importante: Verificar que el clasificador CNO 2001 sea compatible con la base que estes utilizando.

diff --git a/README.Rmd b/README.Rmd
@@ -32,7 +32,7 @@ status](https://codecov.io/gh/holatam/eph/branch/master/graph/badge.svg)](https:
 
 ## Descripción
 
-Si querés procesar datos de la [Encuesta Permanente de Hogares - INDEC](https://www.indec.gob.ar/bases-de-datos.asp)  mediante el lenguaje de programación [R](https://www.r-project.org/), la librería `eph` tiene por objeto facilitar tu trabajo.
+Si querés procesar datos de la [Encuesta Permanente de Hogares (EPH) elaborada por el Instituto Nacional de Estadística y Censos de la República Argentina (INDEC)](https://www.indec.gob.ar/bases-de-datos.asp)  mediante el lenguaje de programación [R](https://www.r-project.org/), la librería `eph` tiene por objeto facilitar tu trabajo.
 
 El paquete cumple un rol fundamental en la democratización de la posibilidad de procesar los datos publicados por INDEC y así obtener conclusiones independientes de aquellas publicadas en los informes elaborados por el organismo. Dado que la información de la EPH constituye una de las principales fuentes para el análisis de las problemáticas sociales presentes en Argentina, el paquete no sólo posibilita investigaciones académicas y periodísticas, sino que también contribuye a la formulación de políticas públicas fundamentadas en evidencia.
 
@@ -43,9 +43,9 @@ Algunas de sus funciones son:
 
 - **`organize_panels()`**: Permite armar un pool de datos en panel de la EPH continua,
 
-- **`organize_cno()`**: Clasifica las ocupaciones según el CNO 2001
+- **`organize_cno()`**: Clasifica las ocupaciones según el Clasificador Nacional de Ocupaciones (CNO) 2001
 
-- **`organize_caes()`**: Clasifica las actividades económicas según CAES Mercosur 1.0 y CAES Mercosur
+- **`organize_caes()`**: Clasifica las actividades económicas según el Clasificador de Actividades Economicas para encuestas Sociodemograficas (CAES) Mercosur 1.0 y el CAES Mercosur
 
 - **`organize_labels()`**: Etiqueta las bases siguiendo el último [diseño de registro](https://www.indec.gob.ar/ftp/cuadros/menusuperior/eph/EPH_registro_t218.pdf)
 
@@ -54,10 +54,13 @@ Algunas de sus funciones son:
 
 El paquete también cuenta con dataframes útiles para el trabajo con la EPH. Algunos de estos son:
 
-- **`diccionario_regiones`**
-- **`diccionario_aglomerados`**
-- **`centroides_aglomerados`**
-- **`adulto_equivalente`**
+- **`diccionario_regiones`**: Diccionario de regiones según el diseño de registro de la EPH
+
+- **`diccionario_aglomerados`**: Diccionario de aglomerados según el diseño de registro de la EPH
+
+- **`centroides_aglomerados`**: Tabla de centroides de los aglomerados (basado en https://www.indec.gob.ar/indec/web/Nivel4-Tema-1-39-120)
+
+- **`adulto_equivalente`**: Tabla de valores de adulto equivalente segun sexo y edad ([ver definición mtodológica](https://www.indec.gob.ar/ftp/cuadros/sociedad/preguntas_frecuentes_cba_cbt.pdf))
 
 ## Instalación
 

diff --git a/README.md b/README.md
@@ -21,10 +21,12 @@ status](https://www.r-pkg.org/badges/version/eph)](https://cran.r-project.org/pa
 
 ## Descripción
 
-Si querés procesar datos de la [Encuesta Permanente de Hogares -
-INDEC](https://www.indec.gob.ar/bases-de-datos.asp) mediante el lenguaje
-de programación [R](https://www.r-project.org/), la librería `eph` tiene
-por objeto facilitar tu trabajo.
+Si querés procesar datos de la [Encuesta Permanente de Hogares (EPH)
+elaborada por el Instituto Nacional de Estadística y Censos de la
+República Argentina
+(INDEC)](https://www.indec.gob.ar/bases-de-datos.asp) mediante el
+lenguaje de programación [R](https://www.r-project.org/), la librería
+`eph` tiene por objeto facilitar tu trabajo.
 
 El paquete cumple un rol fundamental en la democratización de la
 posibilidad de procesar los datos publicados por INDEC y así obtener
@@ -43,10 +45,12 @@ Algunas de sus funciones son:
 - **`organize_panels()`**: Permite armar un pool de datos en panel de la
   EPH continua,
 
-- **`organize_cno()`**: Clasifica las ocupaciones según el CNO 2001
+- **`organize_cno()`**: Clasifica las ocupaciones según el Clasificador
+  Nacional de Ocupaciones (CNO) 2001
 
-- **`organize_caes()`**: Clasifica las actividades económicas según CAES
-  Mercosur 1.0 y CAES Mercosur
+- **`organize_caes()`**: Clasifica las actividades económicas según el
+  Clasificador de Actividades Economicas para encuestas
+  Sociodemograficas (CAES) Mercosur 1.0 y el CAES Mercosur
 
 - **`organize_labels()`**: Etiqueta las bases siguiendo el último
   [diseño de
@@ -57,10 +61,18 @@ Algunas de sus funciones son:
 El paquete también cuenta con dataframes útiles para el trabajo con la
 EPH. Algunos de estos son:
 
-- **`diccionario_regiones`**
-- **`diccionario_aglomerados`**
-- **`centroides_aglomerados`**
-- **`adulto_equivalente`**
+- **`diccionario_regiones`**: Diccionario de regiones según el diseño de
+  registro de la EPH
+
+- **`diccionario_aglomerados`**: Diccionario de aglomerados según el
+  diseño de registro de la EPH
+
+- **`centroides_aglomerados`**: Tabla de centroides de los aglomerados
+  (basado en <https://www.indec.gob.ar/indec/web/Nivel4-Tema-1-39-120>)
+
+- **`adulto_equivalente`**: Tabla de valores de adulto equivalente segun
+  sexo y edad ([ver definición
+  mtodológica](https://www.indec.gob.ar/ftp/cuadros/sociedad/preguntas_frecuentes_cba_cbt.pdf))
 
 ## Instalación
 
@@ -108,7 +120,7 @@ base_individual
 #>  8     546      3        0
 #>  9     509      1        3
 #> 10     509      1        3
-#> # … with 117,310 more rows
+#> # ℹ 117,310 more rows
 ```
 
 ## Cómo citar este paquete

diff --git a/doc/eph.R b/doc/eph.R
@@ -12,109 +12,131 @@ library(purrr)
 library(ggplot2)
 
 ## -----------------------------------------------------------------------------
-ind_3_18 <- get_microdata(year = 2018,
-                          trimester = 2,
-                          type = 'individual')
-
-## ----message=FALSE, warning=FALSE---------------------------------------------
-ind_2_02 <- get_microdata(year = 2001,
-                          wave = 2,
-                          type = 'individual')
+ind_3_18 <- get_microdata(
+  year = 2018,
+  trimester = 3,
+  type = "individual"
+)
 
 ## -----------------------------------------------------------------------------
-ind_3_18 <- organize_labels(df = ind_3_18,
-                            type='individual')
+ind_3_18 <- organize_labels(
+  df = ind_3_18,
+  type = "individual"
+)
 
 ## -----------------------------------------------------------------------------
-hog_3_18 <- get_microdata(year = 2018,
-                          trimester = 3,
-                          type='hogar') %>%
+hog_3_18 <- get_microdata(
+  year = 2018,
+  trimester = 3,
+  type = "hogar"
+) %>%
   organize_labels(.,
-                  type = 'hogar')
+    type = "hogar"
+  )
 
 ## -----------------------------------------------------------------------------
-calculate_tabulates(base = ind_3_18,
-                    x = 'NIVEL_ED',
-                    y = 'CH04',
-                    weights = 'PONDERA',
-                    add.totals = 'row',
-                    add.percentage='col')
+calculate_tabulates(
+  base = ind_3_18,
+  x = "NIVEL_ED",
+  y = "CH04",
+  weights = "PONDERA",
+  add.totals = "row",
+  add.percentage = "col"
+)
 
 ## -----------------------------------------------------------------------------
-calculate_tabulates(base = ind_3_18,
-                    x = 'NIVEL_ED',
-                    y = 'CH04',
-                    add.totals = 'row',
-                    add.percentage = 'col')
+calculate_tabulates(
+  base = ind_3_18,
+  x = "NIVEL_ED",
+  y = "CH04",
+  add.totals = "row",
+  add.percentage = "col"
+)
 
 ## -----------------------------------------------------------------------------
-### Armo vector con el nombre de las variables de interes
-variables <- c('CODUSU','NRO_HOGAR','COMPONENTE','ANO4',
-               'TRIMESTRE','CH04', 'CH06', #variables necesarias para hacer el panel
-               'ESTADO','PONDERA') #variables que nos interesan en nuestro analisis
+### Armo vector con el nombre de las variables de interés incluyendo
+# -variables necesarias para hacer el panel
+# -variables que nos interesan en nuestro análisis
+variables <- c(
+  "CODUSU", "NRO_HOGAR", "COMPONENTE", "ANO4",
+  "TRIMESTRE", "CH04", "CH06", 
+  "ESTADO", "PONDERA"
+) 
 
 ### Descargo la base individual para el 2018_t1
-base_2018t1 <- get_microdata(year = 2018,  trimester = 1,  type = 'individual',
-                       vars = variables)
+base_2018t1 <- get_microdata(
+  year = 2018, trimester = 1, type = "individual",
+  vars = variables
+)
 
 ### Descargo la base individual para el 2018_t2
-base_2018t2 <- get_microdata(year = 2018,  trimester = 2,  type = 'individual',
-                       vars = variables)
+base_2018t2 <- get_microdata(
+  year = 2018, trimester = 2, type = "individual",
+  vars = variables
+)
 
 ### Armo el panel
-pool <- organize_panels(bases = list(base_2018t1, base_2018t2),
-                        variables = c('ESTADO','PONDERA'),
-                        window = 'trimestral')
+pool <- organize_panels(
+  bases = list(base_2018t1, base_2018t2),
+  variables = c("ESTADO", "PONDERA"),
+  window = "trimestral"
+)
 
 ## -----------------------------------------------------------------------------
 pool
 
 ## ----message=FALSE, warning=FALSE---------------------------------------------
 pool %>%
   organize_labels(.) %>%
-  calculate_tabulates(x = 'ESTADO',
-                      y = 'ESTADO_t1',
-                      weights = "PONDERA",
-                      add.percentage='row')
+  calculate_tabulates(
+    x = "ESTADO",
+    y = "ESTADO_t1",
+    weights = "PONDERA",
+    add.percentage = "row"
+  )
 
 ## ----message=FALSE, warning=FALSE---------------------------------------------
-df <- get_microdata(year = 2017:2019,
-                    trimester = 1:4,
-                    type = 'individual',
-                    vars = c('ANO4', 'TRIMESTRE', 'PONDERA','ESTADO','CAT_OCUP'))
+df <- get_microdata(
+  year = 2017:2019,
+  trimester = 1:4,
+  type = "individual",
+  vars = c("ANO4", "TRIMESTRE", "PONDERA", "ESTADO", "CAT_OCUP")
+)
 
 df %>%
   sample_n(5)
 
 ## -----------------------------------------------------------------------------
 df <- df %>%
   group_by(ANO4, TRIMESTRE) %>%
-  summarise(indicador = sum(PONDERA[CAT_OCUP==3 & ESTADO==1], na.rm = T) / sum(PONDERA[ESTADO==1], na.rm = T))
+  summarise(indicador = sum(PONDERA[CAT_OCUP == 3 & ESTADO == 1], na.rm = T) / sum(PONDERA[ESTADO == 1], na.rm = T))
 
 df
 
 ## -----------------------------------------------------------------------------
 lineas <- get_poverty_lines()
-lineas %>% head()
+lineas
 
 ## ---- fig.width=7, fig.height=5-----------------------------------------------
 lineas %>%
   select(-ICE) %>%
   pivot_longer(cols = c("CBA", "CBT"), names_to = "canasta", values_to = "valor") %>%
   ggplot() +
-    geom_line(aes(x=periodo, y=valor, col=canasta))
+  geom_line(aes(x = periodo, y = valor, col = canasta))
 
 ## -----------------------------------------------------------------------------
-canastas_reg_example %>% head()
+canastas_reg_example
 
 ## -----------------------------------------------------------------------------
 adulto_equivalente %>% head()
 
 ## ----warning=FALSE------------------------------------------------------------
 bases <- bind_rows(toybase_individual_2016_03, toybase_individual_2016_04)
-base_pobreza <- calculate_poverty(base = bases,
-                                  basket = canastas_reg_example,
-                                  print_summary = TRUE)
+base_pobreza <- calculate_poverty(
+  base = bases,
+  basket = canastas_reg_example,
+  print_summary = TRUE
+)
 
 ## -----------------------------------------------------------------------------
 base_pobreza %>%