Ric*_*ton 25 documentation packages r documentation-generation roxygen2
我还没有找到一个合理的工作流程来构建包和编写他们的文档.
我希望尽可能多地自动生成流程(和文档).
显而易见的方法是使用package.skeleton创建基本包文件,然后以编程方式覆盖DESCRIPTION文件和Rd文件.这样做的问题在于您丢失了自动生成的字段,确保您记得记录所有正确的参数.
我想知道你如何构建包和编写文档.有没有可用的工具使这个过程更容易？(roxygen看起来像是为这类东西而设计的;有没有一个很好的教程呢？还有其他选择吗？)
Sha*_*ane 19
我在我的所有项目中使用roxygen.举一个例子,浏览源的webvis包.Hadley还使用roxygen作为他的文档(例如,看他的rubridate包).
据我所知,除了vigette之外,没有记录roxygen(看看roxygen主页).
Roxygen是好的,因为它导致了文化编程,从某种意义上说,你的文档和代码是并排的.这也使文档处理变得更容易,因为您一次处理所有事情.我绝对推荐它,并且不会在没有它的情况下开发任何包.
也就是说,它不会在某些文档生成工具(例如javadoc)的意义上自动化文档:roxygen解释格式正确的R注释,但它不以任何方式解释R代码.
关于一般包的创建:package-skeleton对于初学者来说非常棒.一旦你创建了一些软件包,你可能会发现将来更容易创建所有目录,NAMESPACE等.特别是如果您要遵循其他一些做法,例如包括演示目录,使用roxygen,编写插图或包含其他语言的源代码.
最后,我在Eclipse(StatET)中管理我的包; 许多IDE都有"项目"视图,有助于管理包结构,因此您可能还想使用更高级的编辑器.