Come posso aggiungere un file Changelog o NEWS al mio pacchetto R?

Question

Ho un pacchetto su CRAN che vorrei aggiungere un ChangeLog per, ma non riesco a trovare informazioni da nessuna parte su come farlo.

Ho esaminato il documento "Estensioni scrittura R" fornito da CRAN, ma menziona solo ChangeLogs e non fornisce alcuna direzione (potrei trovare) su come crearne uno.

Ho notato dal download di tarball da altri pacchetti su CRAN (ad esempio seacarb) che i loro ChangeLog sono file eseguibili Unix (io sono su un Mac), quindi non è troppo utile.

immagino che questo è un problema comune, ma Googling "changelog R package" solo porta in primo piano i changelog di pacchetti davvero popolari ...

Answer 1

è possibile fornire un file o un file di NEWSChangeLog, o entrambi, per descrivere i cambiamenti nella vostra pacchetto. Devi aggiungere questi file nella cartella di livello superiore del tuo progetto, ovvero nella stessa cartella del tuo DESCRIPTION e NAMESPACE.

Questo è documentato nello R package manual nel paragrafo 1.1 Package structure. In particolare, questo paragrafo punta allo standard GNU:

Per le convenzioni per i file NEWS e ChangeLog nel progetto GNU vedere http://www.gnu.org/prep/standards/standards.html#Documentation.

---

Hadley sottolinea che "In generale si dovrebbe utilizzare un file NEWS, e non ChangeLog. Penso che lo scopo del ChangeLog (alla lista ogni cambio), è stato sussunto dal controllo del codice sorgente".

---

Per creare un file NEWS, è sufficiente creare un file di testo chiamato NEWS nella cartella di primo livello di pacchetto. Si mantiene questo file a mano.

Ecco un estratto dal file NEWS dal mio pacchetto miniCRAN (CRAN link):

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