如何向 R 中的 data.frame 添加文档？

Question

我已经使用 R 一段时间了，我意识到如果您可以附加 data.frame 中包含的描述数据，将会有很大帮助，因为您可以在 .Rdata 文件中收集所有有用的研究信息。

我想添加到我的数据框信息中，就像 ?iris 显示的信息（描述 iris 数据框中的数据）

但是我找不到一种方法来做到这一点。

Answer 1

@Spacedman 对于这类事情有一个很好的通用答案。

如果您想要一些更奇特的东西，您可以尝试 comment()。

 comment(iris) <- 
 "     This famous (Fisher's or Anderson's) iris data set gives the
 measurements in centimeters of the variables sepal length and
 width and petal length and width, respectively, for 50 flowers
 from each of 3 species of iris.  The species are _Iris setosa_,
 _versicolor_, and _virginica_.\n"

 cat(comment(iris))
 # This famous (Fisher's or Anderson's) iris data set gives the
 # measurements in centimeters of the variables sepal length and
 # width and petal length and width, respectively, for 50 flowers
 # from each of 3 species of iris.  The species are _Iris setosa_,
 # _versicolor_, and _virginica_.

Hmisc 包中的 label() 和 units() 提供了记录 data.frames 中各个列的机制。在同一个包中的 contents() 然后汇总您附加到 data.frame 的所有这些属性。

Answer 2

您可以将其添加为任意属性：

attr(df,"doc") = "This is my documentation"

这些内容大部分是通过切片 n 子集来保留的，但某些进程会删除它们。这就是价值传递系统的本质。

CRAN 上甚至可能有一个包，用于将更复杂的元数据作为带有一些包装函数的属性，但在其所有属性之下......

Answer 3

另一种可能性是将您的 df 转换为具有两个字段的正式类（s4，参考类）的对象 - 比如说“data”（您的 df）和“info”（带有描述的字符串）

例如，请参见 ?setRefClass