data()从哪里获取数据集描述?

时间:2015-04-05 11:46:45

标签: r package

不带参数调用data会产生一个可用数据集列表以及每个数据集的简短描述,例如:

!> data()
 Data sets in package ‘datasets’:

 AirPassengers           Monthly Airline Passenger Numbers 1949-1960
 BJsales                 Sales Data with Leading Indicator
 BJsales.lead (BJsales)
                         Sales Data with Leading Indicator
 BOD                     Biochemical Oxygen Demand
 ...

我在包的save()目录中编写了一个包含Rda格式的数据文件(用data/制作)的包,而data()找到它们时,没有 描述

!> data()
 Data sets in package ‘datasets’:

 AirPassengers           Monthly Airline Passenger Numbers 1949-1960
 BJsales                 Sales Data with Leading Indicator
 BJsales.lead (BJsales)
                         Sales Data with Leading Indicator
 BOD                     Biochemical Oxygen Demand
 ...

 Data sets in package ‘fbdata’:

 football.d1
 football.e0
 ...

如何包含数据集的描述?

1 个答案:

答案 0 :(得分:2)

使用?promptData或相应的roxygen2标记为您的数据集生成Rd文件的框架,然后相应地编辑它以添加说明,然后重建包...

正如@hrbrmaster在上面指出的那样,如果确实想要破解数据描述,你可以做这样的事情(plyr包的例子):

datadesc <- file.path(.libPaths()[1],"plyr","Meta","data.rds")
r <- readRDS(datadesc)
r
##      [,1]       [,2]                                                    
## [1,] "baseball" "Yearly batting records for all major league baseball players"
## [2,] "ozone"    "Monthly ozone measurements over Central America."
r[1,2] <- "hacked description"
saveRDS(r,datadesc)

...但我还没有真正测试过这个。

我不知道你的设置是什么,但我认为从长远来看,实际上更经常地重建和重新安装包装会更安全(不会你想更改版本号,以便你可以轻松地告诉用户有权访问哪些版本的数据?)而不是以这种方式破解它...