我还没有完全想出一个合理的工作流程来构建包和编写他们的文档。
我希望尽可能多地自动生成流程（和文档）。
执行此操作的明显方法似乎是使用package.skeleton 创建基本包文件，然后以编程方式覆盖DESCRIPTION 文件和Rd 文件。这样做的问题是，您会丢失自动生成的字段，以确保您记得记录所有正确的参数。
我想知道您是如何构建包和编写文档的。是否有任何工具可以使该过程更容易？ （roxygen 看起来像是为这类事情设计的；有没有好的教程？还有其他选择吗？）
【问题讨论】：
标签： r documentation packages documentation-generation roxygen2
我的所有项目都使用 roxygen。例如，浏览the webvis package 的源代码。 Hadley 还在他的文档中使用了 roxygen（例如，请参阅他的 lubridate package）。
据我所知，roxygen 并没有太多的文档记录（请查看 the roxygen homepage）。
Roxygen 很好，因为它可以引导有文化的编程，从某种意义上说，您的文档和代码是并排的。这也使文档过程更容易一些，因为您可以同时处理所有内容。我绝对推荐它，并且在这一点上不会开发任何没有它的包。
也就是说，它不会像某些文档生成工具（例如 javadoc）那样自动化文档：roxygen 解释正确格式化的 R cmets，但它不会以任何方式解释 R 代码。
关于包的一般创建：package-skeleton 非常适合初学者。一旦您创建了一些包，您可能会发现将来只需手动创建所有目录、NAMESPACE 等就更容易了。特别是如果您要遵循其他一些实践，例如包含演示目录、使用 roxygen、编写小插图或包含其他语言的源代码。
最后，我在 Eclipse (StatET) 中管理我的包；许多 IDE 都有“项目”视图来帮助管理包结构，因此您可能还想使用更高级的编辑器。
【讨论】：
关于 roxygen 资源，后来又出现了几个，又出现了几个，引用my own notes：
当我用谷歌搜索 Roxygen 或 Roxygen2 时，我经常找不到 文档。以下是一些关键资源的汇编：
Hadley Wickham 有一个很棒的introduction to core features of Roxygen 2
RStudio 在running Roxygen上有注释
【讨论】：