tutorial - ¿Cómo agrego un archivo Changelog o NEWS a mi paquete R?
knitr (2)
Tengo un paquete en CRAN para el cual me gustaría agregar un ChangeLog , pero no puedo encontrar información en ningún lugar sobre cómo hacer esto.
Busqué en el documento "Writing R Extensions" que proporciona CRAN, pero solo menciona ChangeLogs y no da ninguna dirección (podría encontrar) sobre cómo crear uno.
Noté que al descargar archivos comprimidos desde otros paquetes en CRAN (por ejemplo, seacarb ), sus ChangeLogs son archivos ejecutables de Unix (estoy en una Mac), por lo que no es muy útil.
Me imagino que este es un problema común, pero al buscar en Google "changelog R package" solo aparece ChangeLogs para paquetes realmente populares ...
Los archivos NEWS.md ahora también son compatibles con CRAN (que los presenta como html) y, más recientemente, con la función de news() .
Puede proporcionar un archivo NEWS o un archivo ChangeLog , o ambos, para describir los cambios en su paquete. NAMESPACE agregar estos archivos en la carpeta de nivel superior de su proyecto, es decir, en la misma carpeta que su DESCRIPTION y NAMESPACE .
Esto se documenta en el manual del paquete R en el párrafo 1.1 Estructura del paquete . En particular, este párrafo apunta al estándar GNU:
Para las convenciones para los archivos NEWS y ChangeLog en el proyecto GNU, consulte http://www.gnu.org/prep/standards/standards.html#Documentation .
Hadley señala que "En general, debe usar un archivo NEWS, y no ChangeLog. Creo que el propósito de ChangeLog (para enumerar todos los cambios), ha sido incluido en el control del código fuente" .
Para crear un archivo de NEWS , simplemente cree un archivo de texto llamado NEWS en la carpeta de nivel superior de su paquete. Mantienes este archivo a mano.
Aquí hay un extracto del archivo NEWS de mi paquete miniCRAN ( enlace CRAN ):
miniCRAN v0.0-21 (Release date: 2014-08-18)
==============
Changes:
* Changes to defaults in plot.pkgDepGraph() to move legend to left of plot area.
miniCRAN v0.0-20 (Release date: 2014-08-18)
==============
Changes:
* Modified examples to reduce running time, mostly using /dontrun{} sections