我有一个关于CRAN的包,我想添加一个ChangeLog
,但我无法在任何地方找到有关如何执行此操作的信息。
我查看了CRAN提供的“Writing R Extensions”文档,但它只提到了ChangeLogs并没有给出关于如何创建一个的指示(我可以找到)。
我注意到从CRAN上的其他软件包(例如seacarb
)下载tarball,他们的ChangeLogs是Unix可执行文件(我在Mac上),所以这不太有帮助。
我想这是一个常见的问题,但谷歌搜索"changelog R package"
只是为真正流行的包提出了ChangeLogs ...
您可以提供NEWS
文件或ChangeLog
文件,或两者,以描述程序包中的更改。您必须将这些文件添加到项目的顶级文件夹中,即与DESCRIPTION
和NAMESPACE
位于同一文件夹中。
这在R package manual段中的1.1 Package structure中有记载。特别是,这一段指向GNU标准:
有关GNU项目中NEWS和ChangeLog文件的约定,请参阅http://www.gnu.org/prep/standards/standards.html#Documentation。
Hadley指出“通常你应该使用一个NEWS文件,而不是ChangeLog。我认为ChangeLog的目的(列出每一个变化)已被源代码控制所包含”。
要创建NEWS
文件,只需在包的顶级文件夹中创建一个名为NEWS
的文本文件。您手动维护此文件。
这是我的包NEWS
(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
现在,CRAN(将其呈现为html)以及最近由news()
函数支持NEWS.md文件。