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

Update README #272

Open
willandru opened this issue Jan 21, 2025 · 0 comments
Open

Update README #272

willandru opened this issue Jan 21, 2025 · 0 comments

Comments

@willandru
Copy link

Archivo README.md revisado, sugiero agregar más contenido referente al ejemplo de ajustar un modelo y/o calcular la Fuerza de infeccion. También sugiero arreglar la seccion de Instalación ya que la rama 'dev' no existe en este momento.


README.md

Installation

  • No hay rama 'dev', no se puede instalar , se puede usar 'main' en su lugar

Quick start

  • Inicia excelente mostrando un dataset modelo.
  • Se espera que se vea rapidamente como se usa el dataset para estimar la Fuerza de Infeccion, de forma que se de una idea muy corta pero lo mas detallada posible.

Links adjuntos

  • La pagina web contiene lo mismo que el README, dicho link no proporciona ninguna información adicional.
  • Los otros links contienen la información que se necesita para entender el paquete. Bien

CONCLUSION

  • Se necesita actualizar el README para que muestre el ejemplo más simple, completo y directo posible de como calcular la Foi.

  • Yo removería la sección Package vignettes (evitar hacer pensar al lector que significa o a que se refiere eso, en dado caso, es un titulo bastante complejo de entender). Pondría los links dentro de la explicación del ejemplo de manera más explicita dentro del flujo o la lectura del lector, no en una seccion aparte.

  • Complementar el README con un ejemplo del calculo de Foi o el ajuste de un modelo

  • Relatar una introduccion sobre la estructura del paquete de una forma más explicita, es decir, decir en la carpeta /data hay 3 ejemplos ....., el paquete tiene unas funciones escritas en stan que se encuentran en la carpeta /stan blalbla, los modulos o funciones de R estan ubicados en la carrpeta /R .... etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant