README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
source("contributors.R")
```

# engihr <img src='man/figures/logo.png' align="right" height="138" />

<!-- badges: start -->
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R build status](https://github.com/endomer-py/engihr/workflows/R-CMD-check/badge.svg)](https://github.com/endomer-py/engihr/actions)
[![Codecov test coverage](https://codecov.io/gh/endomer-py/engihr/branch/main/graph/badge.svg)](https://codecov.io/gh/endomer-py/engihr?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/engihr)](https://CRAN.R-project.org/package=engihr)
<!-- badges: end -->

`engihr` es una interfaz para trabajar con las bases de datos de la Encuesta Nacional de Gastos e Ingresos de los Hogares (ENGIH, 2018, Banco Central) en R. Este paquete es parte de [endomer-py](https://endomer-py.github.io/) un proyecto de código abierto que busca ofrecer interfaces en R para las principales encuestas de la República Dominicana.

## Instalación

`engihr` no está disponible en CRAN.

<!-- ``` r -->
<!-- install.packages("engihr") -->
<!-- ``` -->

Pero puedes instalar la versión de desarrollo desde [GitHub](https://github.com/) con:

``` r
tryCatch(
  library(remotes),
  error = function(e){
    install.packages('remotes')
  }
)
remotes::install_github("endomer-py/engihr")
```
 
## Roadmap

1. Completar el diccionario.

```{r echo=FALSE, message=FALSE}
source("data-raw/dict.R")
Dmisc::progress_bar(length(dict), 445+length(dict1))
rm(dict, dict0, dict1)
```

2. Completar viñeta de uso básico de la librería.
2. Agregar validadores a las funciones para garantizar que las variables son del tipo y con el contenido esperado en los cálculos.
2. Escribir tests.
2. Hacer que todas las funciones trabajen con conexiones a base de datos (Las que usan cut3 específicamente).

## Contribuye

¿Tienes comentarios o quieres contribuir?

Por favor, revisa las [guías de contribución (en inglés)](https://endomer-py.github.io/engihr/CONTRIBUTING.html).

Ten en cuenta que el proyecto `engihr` está sujeto a un [Código del contribuyente](https://contributor-covenant.org/es/version/2/0/CODE_OF_CONDUCT.html). Contribuyendo con el proyecto aceptas los términos y condiciones.



<hr/>

```{r echo=FALSE}
Dmisc::big_button("Guía de inicio rápido", "./articles/engihr.html")
```