R 如何编写软件包文档？

我还没有找到一个合理的工作流程来构建包和编写文档

我希望尽可能多的过程（和文档）自动生成

执行此操作的明显方法似乎是使用

package.skeleton

创建基本包文件，然后以编程方式覆盖

DESCRIPTION

文件和

Rd

文件。这样做的问题是，您会丢失自动生成的字段，这些字段确保您记住记录所有正确的参数

---

我想知道您是如何构建软件包和编写文档的。是否有任何工具可用于简化流程？（看起来它是为这类事情设计的；有好的教程吗？还有其他选择吗？

我所有的项目都使用roxygen。例如，浏览源代码以查找。Hadley还使用roxygen作为文档（例如，参见他的）

据我所知，roxygen除了vigette（请看一看）之外没有太多的文献记载

Roxygen很好，因为它可以实现识字编程，因为您的文档和代码是并排的。这也使得文档编制过程变得更加简单，因为您可以同时处理所有内容。我绝对推荐它，并且在这一点上不会开发没有它的任何包

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

一般来说，关于包的创建：

包框架

对于初学者来说非常好。一旦您创建了几个包，您可能会发现以后只需手动创建所有目录、名称空间等就更容易了。特别是如果您打算遵循其他一些实践，例如包括演示目录、使用roxygen、编写小插曲或包含其他语言的源代码

---

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

关于roxygen资源，后来又出现了几个，还有几个出现了，引用一下：

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

• 哈德利·维克汉姆有一个伟大的梦想

• 有

• RStudio有关于

---

谢谢你的谷歌代码指针。是的，浏览别人的代码并对其进行修补是查看其工作原理的最简单方法。总的来说，roxygen代码非常容易理解，文档也相当完整，因此我没有遇到太多的麻烦来修改它以满足我的需要。谢谢，这非常全面。我将深入研究一些roxygen的代码示例。显然我们现在正在研究roxygen2。这些链接现在都在roxygen2标签页上