roxygen2 未完全更新描述文件

Question

我正在制作我的第一个包裹 rlandscape ，使用 Roxygen2 并尝试遵循普通的 Roxygen 小插图，因为 Roxygen2 没有。

如 the vignette (第 3 页)，我创建了一个名为 rlandscape-package.R 的文件只包含包文档。在小插图中，他们说

each Roxygen description block must be followed by a statement, even header material that describes a le or package in lieu of a specific function. roxygen() is provided as a NOOP (null statement) to stand in for such cases.

但是如果我按照 roxygen() 的描述块进行操作调用 package.skeleton生产 Error in eval(expr, envir, enclos) : could not find function "roxygen" .所以我试着离开 roxygen()完全调用并用 NA 替换它，两者似乎产生相同的结果: package.skeleton()工作成功(包括 rlandscape-package.R 作为 code_files 参数之一)，然后我可以 roxygenize

> roxygenize("rlandscape", roxygen.dir = "rlandscape")
Updating collate directive in  /Users/Gregor/Dropbox/rlandscape/rlandscape/DESCRIPTION 
Updating namespace directives
Writing plot.landscape.Rd
Writing rland.Rd
Writing rland.gui.Rd
Writing makePoints.Rd
Writing rCluster.Rd
Writing rlandscape-package.Rd
Writing rlandscape.Rd

似乎运行成功，但描述文件附加了“整理”字段，但与 package.skeleton 的内容没有变化创建。为什么描述文件的其余部分没有更新？

Answer 1

roxygen2 正在按预期工作，但是当我第一次使用它来记录包时，我遇到了同样的困惑。要理解的重要一点是混合中有几个不同的包描述文件。

当 rlandscape-package.R 中的 roxygen 标记被处理，它产生一个文件 rlandscape-package.Rd在源包的 man 目录中。这反过来会生成您在键入 ?rlandscape 时看到的文档。或 ?"rlandscape-package" .

DESCRIPTION源代码树顶部目录中的文件是一个完全独立的野兽。尽管它碰巧生成了一个您可以看到的帮助文件(通过 help(package="rlandscape") )，但它在指导软件包生产方面还有许多其他更重要的作用。 只有 接触/影响它的方式roxygen2 是collate_roclet()函数(在您 roxygenize() 您的包时执行)将与预先存在的 DESCRIPTION 中的 Collat​​e 字段执行合并。文件(如 this pdf 的第 10 页所述)。

主要的信息是，即使在使用 roxygen2 时，如果您想对您的 DESCRIPTION 进行更改文件，您需要通过直接编辑它来完成。