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

标签 r roxygen2

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

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

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

最佳答案

另一种(更简单)的方法是使用 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 

关于r - 可以为不在包中的对象创建 Rd 帮助文件吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18923405/

相关文章:

r - 解释 R 中 glmnet 中的系数名称

r - 在 R 中绘制系数和置信区间

Rstudio Roxygen2 @importFrom 解析函数头

r - S3 泛型/方法一致性 - 如何根据所选类型进行调度?

html - R:检查 url 是否存在,httr:GET() 和 url.exists() 的问题

r - 使用 kable() 生成跨越多个页面的表

r - 如何在ggplot2中的堆叠条组之间放置空间

r - 使用 roxygen 记录 setter 函数

r - S4 类交叉引用 - 什么是合适的语法?

roxygen2 不生成 .Rd 文件