r - 您如何编写包装文件？

Closed. This question does not meet Stack Overflow guidelines。它当前不接受答案。












想改善这个问题吗？更新问题，以便将其作为on-topic用于堆栈溢出。

3年前关闭。



Improve this question




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

我希望尽可能多的过程(和文档)能够自动生成。

这样做的显而易见的方法似乎是使用package.skeleton创建基本的软件包文件，然后以编程方式覆盖DESCRIPTION文件和Rd文件。这样做的麻烦在于，您将丢失自动生成的字段，这些字段将确保您记得已记录了所有正确的参数。

我想知道您如何构建软件包和编写文档。有没有可用的工具来简化该过程？ (roxygen看起来像是为这种事情设计的；是否有不错的教程？还有其他替代方法吗？)

最佳答案

我在所有项目中都使用了roxygen。例如，浏览the webvis package的源代码。 Hadley还使用了roxygen作为文档(例如，参见他的lubridate package)。

就我所知，roxygen的用法和样例没有太多记载(请参阅the roxygen homepage)。

Roxygen很好，因为它可以导致有素的编程，在某种意义上说，您的文档和代码是并行的。由于您可以一次处理所有内容，因此这也使文档编制过程变得容易一些。我绝对推荐它，并且如果没有它，将不会开发任何软件包。

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

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

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