使用roxygen2记录多个数据对象

时间:2016-12-09 11:15:52

标签: r roxygen2

我正在编写一个R包,其中包含要加载的数据集,比如data(temp)。我正在使用roxygen2进行文档编制。在我的data/目录中,只有一个文件temp.rda包含多个对象,因此data(temp)会将多个变量var1var2 ...放入工作区。为了记录数据集temp,我创建了一个文件R/temp.R,其中包含通常的roxygen2数据集文档(@docType data@name temp,以及包含@format字段的var1字段var2roxygenise()等解释的项目符号列表。 ?temp成功,可以构建和安装软件包,R CMD check按预期工作。

现在var1会针对未记录的数据集var2All user-level objects in a package should have documentation entries. 等发出警告,因为

R/temp.R

我可以通过向var1添加其他文档块来解决此问题,分别记录每个var2temp等,就像我上面对var*所做的那样。但是temp的文档中已经描述了所有temp我应该如何修改?var1的文档块,以便?temp只是重定向到data(temp)

在相关的说明中:document.write('Something'); var d = document; // So that i need not to repeat document everytime d.write('SomethingElse'); //Working var w = write(); // or w = write d.w("Something"); //Not Working 加载多个对象(在我的情况下为6个)是否被视为不良做法?

0 个答案:

没有答案