25

我还没有完全想出一个合理的工作流程来构建包和编写他们的文档。

我希望尽可能多地自动生成流程（和文档）。

这样做的明显方法似乎是使用package.skeleton创建基本包文件，然后以编程方式覆盖DESCRIPTION文件和Rd文件。这样做的问题是您会丢失自动生成的字段，这些字段确保您记得记录所有正确的参数。

我想知道你是如何构建包和编写文档的。是否有任何工具可以使该过程更容易？（roxygen看起来像是为这类事情设计的；有没有好的教程？还有其他选择吗？）

4

2 回答 2

19

我在所有项目中都使用 roxygen。例如，浏览webvis包的源代码。Hadley 还在他的文档中使用了 roxygen（例如，参见他的lubridate 包）。

据我所知，roxygen 的文档并没有太多超出 vigette（请查看roxygen 主页）。

Roxygen 很好，因为它导致了文学编程，从某种意义上说，您的文档和代码是并排的。这也使文档过程更容易一些，因为您可以同时处理所有内容。我绝对推荐它，并且在这一点上不会开发任何没有它的包。

也就是说，它不会像某些文档生成工具（例如 javadoc）那样自动化文档：roxygen 解释格式正确的 R 注释，但它不会以任何方式解释 R 代码。

关于包的创建一般：package-skeleton非常适合初学者。一旦您创建了一些包，您可能会发现将来只需手动创建所有目录、NAMESPACE 等就更容易了。特别是如果您要遵循其他一些实践，例如包含演示目录、使用 roxygen、编写小插图或包含其他语言的源代码。

最后，我在 Eclipse (StatET) 中管理我的包；许多 IDE 具有帮助管理包结构的“项目”视图，因此您可能还想使用更高级的编辑器。

于 2010-06-21T15:48:43.353 回答
1

关于 roxygen 资源，后来又出现了几个，又出现了几个，引用我自己的笔记：

通常当我用谷歌搜索 Roxygen 或 Roxygen2 时，我很难找到文档。以下是一些关键资源的汇编：

于 2014-09-03T07:47:20.403 回答