r - 可以为不在包中的对象创建 Rd 帮助文件吗？

Question

我正在使用 Rstudio 简化 Sweave 和 R 进行数据分析，我将与其他分析师分享。为了使变量的编码更加清晰，最好有一个帮助文件这样他们可以调用?myData。并获得有用的文件，如果他们需要的话。我喜欢 Rd Markdown ，并认为它实际上具有记录分析数据集的巨大潜力，包括总体摘要、按变量分割的变量以及如何运行一些探索性分析的示例。

如果您专门创建一个包，这样做很容易，但我认为这很令人困惑，因为包最终是函数的集合，并且它们不集成 Rnw 文件。

我可以使用 Roxygen2 为不属于任何包的数据集创建帮助文件吗？

Answer 1

另一种(更简单)的方法是使用 document包裹:

> document::document("~/Downloads/tmp.R") #your temporal R file to convert to Rd 
# it brings an error, but document are correctly built in a temporal directory 
# (copy the path in below variable: tmppath)

> tmppath <- "/var/folders/dl/zj51mknn0x17lp376dpx_j3r0000gn/T//RtmpaikYJb/document_8e706d7cd54a/tmp/man"
> rstudioapi::previewRd(paste0(tmppath, "/tmp.Rd")) #to preview