你如何编写包文档?

时间:2010-06-21 15:41:26

标签: r documentation packages documentation-generation roxygen2

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

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

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

我想知道如何构建包和编写文档。有没有可用的工具使这个过程更容易? (roxygen看起来像是为这类东西而设计的;是否有一个很好的教程?还有其他选择吗?)

2 个答案:

答案 0 :(得分:19)

我在所有项目中使用roxygen。例如,浏览the webvis package的来源。 Hadley还使用roxygen作为他的文档(例如,见他的lubridate package)。

据我所知,除了vigette之外,没有记录roxygen(看看the roxygen homepage)。

Roxygen是好的,因为它会带来文字编程,因为你的文档和代码是并排的。这也使文档处理变得更容易,因为您一次处理所有事情。我绝对推荐它,并且在此时不会开发任何包。

也就是说,它并没有在文档生成工具的意义上自动化文档(例如javadoc):roxygen解释格式正确的R注释,但它不以任何方式解释R代码。 / p>

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

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

答案 1 :(得分:1)

关于roxygen资源,引用my own notes引用了更多的资源,引发了更多资源:

  

通常当我谷歌Roxygen或Roxygen2时,我很难找到   文档。这是一些关键资源的汇编:

     
豫ICP备18024241号-1