开发自己的R包–提高篇

这篇文章关注R代码写完后,文档生成,包检查和提交相关的问题。

在R代码写完以后,并利用前面的vim插件生成文档模板后,需要人工完善文档。假设完成后的R文件名为rstatscn.R
这些都做完以后,利用package.skeleton函数来生成模块文件。

package.skeleton(name="rstatscn",code_files='path/to/rstatscn.R')

当前目录下会生成目录rstatscn. 接下来利用roxygen2来生成文档

roxygenise("/home/xuyang/rstatscn/")

roxygenise会为每个函数生成一个以函数名命名的Rd文档,对于哪些不需要导出的函数文档,可以手动删除。不删除也可以,这样的话就会在包的说明文档的index中看到这些未导出的函数。但这个似乎关系也不大。

接下来要做的,就是build和check过程,见另一篇博客。
不过要提交你的包到cran,你需要在检查的时候,加上–as-cran参数。 即 R CMD check –as-cran rstatscn
在这个检查通过以后,还需要提交一个windows下的检查。这个可以通过 http://win-builder.r-project.org 网站来实现,你只需要提交你的包到这里, 他就会自动为你在windows下检查这个包。检查完成会发送一个email告诉你,windows检查以后就可以最后提交你的包到cran了。

另外在cran检查的时候,修改全局变量是不允许的,如果要使用全局变量,可以使用新建一个environment,然后通过get和assign变量的方法来实现。如下所示:

rstatscnEnv<-new.env()
....
assign('lastQuery',curQuery, envir=rstatscnEnv)
...
curQuery=get('lastQuery', envir=rstatscnEnv)


本文地址: http://www.bagualu.net/wordpress/archives/4999 转载请注明




发表评论

电子邮件地址不会被公开。 必填项已用*标注