在该数据的文档中包含使用数据的示例（在开发 R 包时）答案

【问题标题】：Include example using data in documentation of that data (when developing R package)在该数据的文档中包含使用数据的示例（在开发 R 包时）
【发布时间】：2014-06-27 01:09:11
【问题描述】：

在 R 包中的数据文档中（通过 Rstudio 使用 Roxygen），是否可以包含使用该数据的示例？

例如R目录下的TestPackage.R

#' My New Colour
#' 
#' Enables use of my new colour \emph{aNewColour} in plots.
#' @name aNewColour
#' @docType data
#' @format A colour defined by rgb(red=232,green=81,blue=0,maxColorValue=255)
#' @usage data(allNewColours)
#' @examples
#' curve(dnorm,from=-4,to=4,col=aNewColour,lwd=2)
NULL

在同一个 R 目录中，我有一个文件：allNewColours.rda，它只包含变量 aNewColour，其值为 #E85100 .

当我在 R studio 的 Build 菜单上按 Check 时（我相信相当于命令 R CMD Check），我得到以下错误信息：

** 示例

curve(dnorm,from=-4,to=4,col=aNewColour,lwd=2) plot.xy(xy, type, ...) 中的错误：找不到对象“aNewColour”调用：曲线->情节-> plot.default -> plot.xy 执行停止错误：命令失败 (1) 执行停止

以状态 1 退出。

是否可以使用“aNewColour”文档示例中的数据“aNewColour”？

编辑：好的，我发现了我的问题 - 如果我将 .rda 文件移动到数据文件夹（与 R在同一级别> 文件夹，所有作品）... 多年来一直在努力解决这个问题，只是为了在发布此问题后的几秒钟内确定解决方案...

【问题讨论】：

查看编辑以获取问题的解决方案。这现在有效。我需要将我的 .rda 文件放在与 R 目录相同级别的数据目录中
还需要注意的是，这个例子需要在DESCRIPTION文件中使用LazyData:yes，否则不起作用。
作为官方答案并标记为正确
顺便说一句，使用 roxygen2，您现在可以记录 "aNewColour"，它会用正确的值填写名称等

标签： r package rstudio roxygen

【解决方案1】：

将 .rda 文件移动到数据文件夹 - 并在说明文件中输入 LazyData: yes

【讨论】：