rOpenSci

.title[
# rOpenSci
]
.subtitle[
## .lighty[<em>Paquete {eph}: Novedades e ideas para su uso</em>]
]
.author[
### Carolina Pradier
]
.date[
### .black[2023/12/15]
]

---

En el marco del [rOpenSci Champions Program](https://ropensci.org/champions/), el paquete .bg-lila[eph] atravesó el proceso de [Software Peer Review](https://devguide.ropensci.org/softwarereviewintro.html)

![](icon_lettering_color.png)

---

# Bienvenides!

--
El plan para hoy:

1.Les presentamos las .bg-lila[novedades] del paquete eph, cómo se mejora un paquete?

2..bg-lightgreen.white[Dos avances gracias a eph::get_microdata()] con *Valentín Alvarez (EIDAES-UNSAM / FCE-UBA)*

3..bg-lightgreen.white[De la caja de herramientas en pendrive a la caja de herramientas en R: el paquete eph] con *Vladimiro Torres (EIDAES-UNSAM / FCE-UBA)*

4..bg-lightgreen.white[Paquete eph y CEPED-DATA: dos proyectos, una misma filosofía] con *Guido Weksler (CONICET / CEPED-FCE-UBA)*

---

---

# A. Estudiar y entender el paquete

**.black[1] .white[¿Qué hacen mis funciones?]**

**.black[2] .white[Dependencias]**

**.black[3] .white[Experiencia del usuario]**

---

## ¿Qué hacen mis funciones?

.pull-left[.left[**[Las funciones de nuestro paquete](https://ropensci.github.io/eph/reference/index.html)**

- Descarga y recodificación

*get_microdata(), organize_caes(), organize_cno(), organize_labels(), organize_panels(), get_total_urbano(), get_eahu(), get_poverty_lines()*

- Procesamiento

*calculate_errors(), calculate_poverty(), calculate_tabulates(), map_agglomerates()*]]

Son fáciles de **.bg-lightgreen.white[leer]**? Fáciles de modificar? (¿Hay estructuras condicionales complejas?)

Los .lila[nombres] de mis funciones y sus argumentos son intuitivos? Son consistentes  (e.g. snake_case or camelCase)? Está bien la .purple[indentación]?

Son a prueba de usuarios? Los errores y advertencias contra **.red[inputs inválidos]** son fáciles de entender?

---

## Dependencias

El paquete tiene **.bg-lightgreen.white[demasiadas]** dependencias? (aprox 20 máx)

Qué *.yellow[función]* depende de cada *.yellow[paquete]*?

Cuántas *.yellow[funciones]* de cada *.yellow[paquete]* usamos?

Podemos obtener el mismo resultado usando .white.bg-darkgreen[R base]?
    
--

</br>

---

## Experiencia del usuarie

Los mensajes de **.red[error]** y **.yellow[advertencia]** son claros y útiles? (les usuaries hablan *ingés*?)

**Documentación** y **sitio del paquete**

.pull-left[Escuchar a les usuaries: hay .bg-lila.black[issues]?
https://github.com/ropensci/eph/issues]

---

# B. Mejorando el paquete

**.black[1] .white[Recursos útiles]**

**.black[2] .white[Git branches, checks y tests]**

**.black[3] .white[Mejorar las funciones]**

---

## Recursos útiles

- [Casi todo lo que alguien puede necesitar saber sobre los paquetes de R](https://r-pkgs.org/)

- [Los materiales](https://masalmon.eu/all/) de [Maëlle Salmon](https://github.com/maelle)

- Cómo mejorar nuestras [funciones](https://r4ds.had.co.nz/functions.html) y su [desempeño](https://adv-r.hadley.nz/perf-improve.html)

- Las [dependencias](https://r-pkgs.org/dependencies-mindset-background.html) de un paquete

---

## Git branches, checks y tests

Cómo asegurarnos de no romper nada?

1-Usando **.bg-lightgreen.white[git branches]** para cambios grandes

2-Corriendo **.yellow[tests]** (usando [testthat](https://testthat.r-lib.org/)) y **.red[checks]** frecuentemente

---

## Mejorar las funciones

Código .bg-yellow.black[elegante] (e.g.: early returns)

Asegurar compatibilidad con versiones anteriores: .bg-lightgreen.white["..."]

Mejorar **legibilidad**: considerar nombres, comentarios, estructuras condicionales, etc.

</br>

.pull-left[.left[Dejamos dos videos que explican en más profundidad de qué se tratan estas mejoras ([inicial](https://www.youtube.com/watch?v=7oyiPBjLAWY&t=2797s) y [avanzado](https://www.youtube.com/watch?v=2BXPLnLMTYo))]]

---

# C. Resultados: Cuáles son las novedades del paquete .lila[_eph_]?

**.black[1] .white[Funciones nuevas]**

**.black[2] .white[Código y dependencias]**

**.black[3] .white[Documentación y mensajes de error]**

---

## Funciones nuevas

Sumamos dos funciones nuevas: .white.bg-darkgreen[get_total_urbano()] y .white.bg-darkgreen[get_eahu()] para descargar las **Encuestas Anuales de Hogares Urbanos**.

---

## Código y dependencias

Reestructuramos las .white.bg-darkgreen[funciones] para un código más limpio, eficiente y legible. El código ahora sigue las pautas de estilo de tidyverse.

Modificamos la función .white.bg-darkgreen[get_microdata()] para evitar conflictos de parámetros entre trimestre y onda.

Redujimos las dependencias, recurriendo más a .white.bg-darkgreen[R base].

</br>

```r
link = glue::glue("https://www.indec.gob.ar/ftp/cuadros
                 /menusuperior/eph/EPH_usu_{trimester}_Trim_{year}_txt.zip")
```

```r
link= sprintf('https://www.indec.gob.ar/ftp/cuadros
              /menusuperior/eph/EPH_usu_%s_Trim_%s_txt.zip',
              trimester,year)
```

---

## Documentación y mensajes de error

Mejoramos la documentación y el [sitio web del paquete](https://ropensci.github.io/eph/). Por otro lado, las mejoras (y traducciones) en los mensajes de **.red[error]** y **.yellow[advertencia]** hacen que trabajar con el paquete sea más intuitivo. Les usuaries no deberían necesitar **conocimiento experto** para trabajar con nuestros datasets.

Al correr este código (la variable departamentos no existe):

```r
calculate_tabulates(x = "departamentos", add.percentage = "col")
```

El mensaje de error era este:

```r
Error in model.frame.default(formula = ~x_vec, data = base) :
  invalid type (NULL) for variable 'x_vec'
```

Y ahora:

```r
Error in `calculate_tabulates()`:
! La variable x no pertence a la base de datos
ℹ Puede usar names() para extraer los nombres de las variables.
```

---

# Gracias!