Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Collaboration Guidelines #5

Open
DiegoKoz opened this issue Feb 7, 2019 · 1 comment
Open

Collaboration Guidelines #5

DiegoKoz opened this issue Feb 7, 2019 · 1 comment

Comments

@DiegoKoz
Copy link
Collaborator

@DiegoKoz DiegoKoz commented Feb 7, 2019

Bienvenides 🎉 🎉 🎉

El objetivo de esta librería es construir un Toolbox para el procesamiento de la Encuesta Permanente de Hogares (indec)

Para agregar tu función te pedimos que sigas los siguentes pasos:

  1. Hace un fork de este repositorio
  2. Agregues tu función como un archivo .R en la carpeta R/ con el mismo nombre que la función
  3. 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
  4. Recordá que para que tu función se pueda utilizar, al final de la documentación debes agregar un
    #' @export
  5. Controla que los tipos y valores de los parametros de tu función estén bien (para un ejemplo, podes mirar get_microdata.r
  6. Agrega las dependencias en el archivo DESCRIPTION
  7. Chequea el paquete con devtools::check()
  8. Si todo funciona bien, entonces hace un pull request

obs. Te pedimos que en la medida de los posible trates de seguir la guía de estilo del Tidyverse que va a simplificar mucho la lectura del código y la usabilidad de la librería
obs. En un futuro esperamos agregar test de la librería con testthat.

@DiegoKoz DiegoKoz added this to To do in MVP via automation Feb 7, 2019
@DiegoKoz
Copy link
Collaborator Author

@DiegoKoz DiegoKoz commented Feb 20, 2019

Nombres de Funciones

Para mantener la cohesión interna de la librería, decidimos el siguiente esquema de nombres para funciones:

  • Las mismas deben ser escritas en inglés, al igual que los parametros que utilicen.
  • funciones que descargan datos get_{microdata | poverty_lines}
  • funciones que calculan cosas calculate_{poverty | tabulates}
  • funciones que organizan los datos organize_ {labels | panels}
  • funciones que estiman cosas estimate_{confint}
@DiegoKoz DiegoKoz moved this from To do to Done in MVP Feb 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
MVP
  
Done
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.