如何在 R 包中共享小插图文档中的对象?

How to share objects in vignettes documentation in a R package?

我正在使用 vignettes(将嵌入到 pkgdown 网站中)为我的 R 包编写文档。
我的问题是: 如果我在第一个“aa”小插图中的一个块中创建一个 R 对象。

myobject <- mypkg::myfct()

如何在名为“bb”的第二个小插图中重复使用此对象?

verif <- myobject[myfilters,]

我收到此错误:找不到我的对象

这似乎不是个好主意。 您可以将此数据保存在内部 RDA 文件中,然后将其加载到第二个小插图中。参见 Chapter 14 External data, R Pakcages

所以你必须:

  • 创建一个 data_raw 文件夹,并有一个脚本来创建这个对象,然后保存它。 usethis::use_data_raw 促进了这一点,例如“myfct_example”。
  • 然后,在 data_raw 这个脚本的底部确保 internal = TRUE;这会将对象保存在 R/sysdata.rda 中,而不是 data/myfct_example 中(如果你这样称呼该对象)。
  • 确保每次更改 myfct_example 时都 运行 data_raw/myfct_example 脚本,以便新版本存储在 R/sysdata.rda.
  • 在这两个小插图中,您将通过 mypkg:::myfct_example 获得此数据对象。