Как добавить файл Changelog или NEWS в свой пакет R?

У меня есть пакет на CRAN, который я хотел бы добавить ChangeLog для, но я не могу найти информацию в любом месте о том, как это сделать.

Я просмотрел документ "Написание R-расширений", который предоставляет CRAN, но он только упоминает ChangeLogs и не дает никакого направления (я могу найти) о том, как его создать.

Я заметил, что при загрузке tarball из других пакетов на CRAN (например, seacarb) их ChangeLogs являются исполняемыми файлами Unix (я нахожусь на Mac), поэтому не слишком полезно.

Я предполагаю, что это распространенная проблема, но Googling "changelog R package" просто вызывает ChangeLogs для действительно популярных пакетов...

Ответы

Ответ 1

Вы можете предоставить файл NEWS или файл ChangeLog или оба, чтобы описать изменения в вашем пакете. Вы должны добавить эти файлы в папку верхнего уровня вашего проекта, то есть в той же папке, что и ваши DESCRIPTION и NAMESPACE.

Это описано в Руководстве по пакетам R в разделе 1.1 Структура пакета. В частности, этот параграф указывает на стандарт GNU:

В соглашениях для файлов NEWS и ChangeLog в проекте GNU см. http://www.gnu.org/prep/standards/standards.html#Documentation.

Хэдли указывает, что "Как правило, вы должны использовать файл NEWS, а не ChangeLog. Я думаю, что цель ChangeLog (перечислить каждое изменение) была включена в систему управления исходным кодом".

Чтобы создать файл NEWS, просто создайте текстовый файл с именем NEWS в папке верхнего уровня вашего пакета. Вы сохраняете этот файл вручную.

Вот выдержка из файла NEWS из моего пакета miniCRAN (ссылка 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