Jak dodać plik Changelog lub NEWS do mojego pakietu R?

Question

Mam pakiet na CRAN, który chciałbym dodać do ChangeLog, ale nie mogę znaleźć nigdzie informacji, jak to zrobić.

Przyjrzałem się dokumentowi "Writing R Extensions" dostarczonemu przez CRAN, ale wspomina on tylko o dziennikach zmian i nie daje żadnego kierunku (mógłbym znaleźć) o tym, jak go utworzyć.

Zauważyłem, że podczas pobierania archiwów z innych pakietów na CRAN (na przykład seacarb) ich dzienniki zmian są uniksowymi plikami wykonywalnymi (jestem na komputerze Mac), więc nie jest to zbyt pomocne.

sobie wyobrazić, że jest to wspólny problem, ale Googling "changelog R package" tylko wywołuje zmian dla bardzo popularnych pakietów ...

Answer 1

Można też dostarczyć plik NEWS lub plik ChangeLog lub oba, aby opisać zmiany w pakiet. Musisz dodać te pliki w folderze najwyższego poziomu projektu, tj. W tym samym folderze, co Twój DESCRIPTION i NAMESPACE. To jest udokumentowane w R package manual w akapicie 1.1 Package structure. W szczególności, ten akapit wskazuje standard GNU:

Konwencje dotyczące plików NEWS i ChangeLog w projekcie GNU patrz http://www.gnu.org/prep/standards/standards.html#Documentation.

---

Hadley wskazuje, że „Generalnie należy użyć pliku NEWS, a nie zmian. Myślę, że celem zmian (notować każdą zmianę), zostało podciągnięte przez kontrolę kodu źródłowego”.

---

Aby utworzyć plik NEWS, wystarczy utworzyć plik tekstowy o nazwie NEWS w folderze górnym poziomem pakietu. Przechowujesz ten plik ręcznie.

Oto fragment z pliku NEWS z mojego pakietu 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