Collaboration Guidelines

[RichDeto]

Aportes de la comunidad

Este paquete se propone incorporar cualquier función de propósitos generales que utilice como base le Encuesta Continua de Hogares (ECH) de Uruguay. Todos los aportes en este sentido son bienvenidos.

Si trabajas con la ECH de Uruguay y querés agregar tu función o tus datos, te recomendamos que leas los siguientes consejos de como colaborar:

Para agregar tu función:

- Haz un fork de este repositorio
- Agrega tu función como un archivo .R en la carpeta R/ con el mismo nombre que la función
- Documenta la misma con roxygen2 aclarando su funcionalidad, los parámetros y un ejemplo de uso. Para ver como se documenta poder revisar otra de las funciones en ese mismo directorio
- Recuerda que para que tu función se pueda utilizar, al final de la documentación debes agregar un #' @export
- Controla que los tipos y valores de los parametros de tu función estén bien (para un ejemplo, podes mirar `data-raw/metadata.R`
- Agrega las dependencias en el archivo `DESCRIPTION`
- Chequea el paquete con devtools::check()
- Si todo funciona bien, entonces hace un pull request

---

Community contributions

This package intends to incorporate any function of general requirements that use the "Encuesta Continua de Hogares" (ECH) of Uruguay as a base. All contributions in this regard are welcome.

If you work with ECH data of Uruguay and want to add your function or data, we recommend that you read the following tips on how to collaborate:

To add your function:

- Fork of this repository
- Add your function as an `.R` file in the `R/` folder with the same name as the function
- Document it with `roxygen2` clarifying its functionality, parameters and an example of use. To see how it is documented to review another function in the same directory
- Remember at the end of the documentation you must add a # '@export
- Check that the types and values of your function parameters are fine (for example, you can look at `data-raw/metadata.R`
- Add the dependencies in the `DESCRIPTION` file 
- Check the package with devtools::check()
- If everything works fine, then make a pull request