如何将Changelog或NEWS文件添加到R包中？

Question

我在CRAN上有一个包,我想添加一个ChangeLogfor,但我无法在任何地方找到有关如何执行此操作的信息.

我查看了CRAN提供的"Writing R Extensions"文档,但它只提到了ChangeLogs并没有给出关于如何创建一个的指示(我可以找到).

我注意到从CRAN上的其他软件包下载tarball(例如seacarb)他们的ChangeLogs是Unix可执行文件(我在Mac上),所以这不太有用.

我想这是一个常见的问题,但谷歌搜索"changelog R package"只是为真正受欢迎的软件包带来了ChangeLogs ......

Answer 1

您可以提供NEWS文件或ChangeLog文件,或两者都提供,以描述程序包中的更改.您必须将这些文件添加到项目的顶级文件夹中,即与您DESCRIPTION和的文件夹在同一文件夹中NAMESPACE.

这在1.1包装结构的R包手册中有记载.特别是,这一段指向GNU标准:

有关GNU项目中NEWS和ChangeLog文件的约定,请参阅http://www.gnu.org/prep/standards/standards.html#Documentation.

Hadley指出"通常你应该使用一个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

Answer 2

NEWS.md 文件现在也受 CRAN（将它们呈现为 html）和最近的news()功能支持。

https://cran.r-project.org/doc/manuals/r-devel/NEWS.html