Review: Nice to have

[mauro-ixpantia]

Relacionado a:

• Hacer un nuevo release a CRAN #176
• Upkeep for ixplorer (2024) #177
• Preparar el release v0.3.5 #178

Este tiquete registra sugerencias que no estan capturadas en los tiquetes #177 y #178 (generados automaticamente por usethis). Creo que son cosas relativamente menores.

Tags y changelog

• Considerar automatizar la creacion de tags y la gestion del changlog con fledge:

Streamline the process of versioning R packages and updating NEWS

README

• Mostrar un ejemplo simple, por ejemplo lo que veo en este articulo.
• En la instrucciones de instalacion considerar usar pak::pak()
• Para mostrar traducciones en forma compacta considerar usar un dropdown, por ejemplo:

SP

Castellano aca

EN

English here

Se logra asi:

<details><summary>EN</summary>

English here

</details>

Get Started

• Las instrucciones para instalar gitear no son necesarias. Gitear es una dependencia de ixplorer, asi que se instala automaticamente al instalar ixplorer.

Vignettes y Articulos

• Considerar convertir los vignettes a articulos. Esto reduce el "peso" de lo que se instala. Las vignetas se instalan pero los articulos no -- y aparecen solamente en el website. Ademas, en el directorio vignettes veo un archivo .R por cada .Rmd. Puede evitarse?

• En el website los articulos aparecen por orden alfabetico. Considerar re-organizarlos para que aparezcan en el orden en que un usuario deberia leerlos, por ejemplo de basico a avanzado.

Reference

• Considerar agrupar funciones similares (ejemplo)

Style

• Considerar usar styler::style_pkg().

tests/

• Considerar agregar mas tests y estructurarlos como esta documentado aca.

DESCRIPTION

• Creo que la "nueva mejor practica" es no especificar las versiones de todos los paquetes en Imports:, Suggests:, etc. Considerar reservar la especificacion solo para los paquetes que realmente tienen una incompatibilidad conocida en alguna version antigua. Por ejemplo aca hay un paquete relativamente nuevo en CRAN donde se puede ver que la mayoria de las dependencias no tienen especificacion de version: https://github.com/RConsortium/S7/blob/main/DESCRIPTION.