我正在使用Rstudio来简化Sweave和R的数据分析，我将与其他分析师分享。为了使变量的编码非常清晰，最好有一个帮助文件之类的东西，这样他们就可以在需要时调用?myData并获得有用的文件。我喜欢 Rd markdown 并认为它实际上具有记录分析数据集的巨大潜力，包括总体摘要、逐个变量细分以及如何运行一些探索性分析的示例。
如果您专门创建包，则很容易做到这一点，但我认为这很令人困惑，因为包最终是函数的集合，并且它们不集成 Rnw 文件。
是否可以使用 Roxygen2 为不属于任何包的数据集创建帮助文件？
在我对此进行破解之前，我想重申其他人所说的话。R的包装系统正是您正在寻找的。许多人成功地使用它来分发数据而不分发代码。结合 R 的延迟加载数据，您可以将大型数据集作为包分发，而不会给不希望加载所有数据集的用户带来负担。
此外，除非您使用软件包，否则您将无法利用 R 的帮助系统。原始问题明确询问有关使用 ?myData，如果您不使用包，您的用户将无法执行此操作。这很简单，是 R 的基本帮助函数的限制。
现在，回答这个问题。您将需要使用一些非导出的roxygen函数来完成这项工作，但它并不太繁重。此外，您需要将记录数据的 R 文件放入它们自己的文件夹中的某个位置，在该文件夹中，您需要创建一个名为 man 的空文件夹。
目录结构示例：
# ./
# ./man/
# ./myData.R
# ./otherData.R
myData.R
#' My dataset
#'
#' This is data I like.
#'
#' @name myData
NULL
otherData.R：
#' My other dataset
#'
#' This is another dataset I like
#'
#' @name otherData
NULL
所有这些结合在一起的代码（当然，您可以将其包装在一个函数中）：
library(roxygen2)
mydir <- "path/to/your/data/directory/"
myfiles <- c("myData.R","otherData.R")
# get parsed source into roxygen-friendly format
env <- new.env(parent = globalenv())
rfiles <- sapply(myfiles, function(f) file.path(mydir,f))
blocks <- unlist(lapply(rfiles, roxygen2:::parse_file, env=env), recursive=FALSE)
parsed <- list(env=env, blocks=blocks)
# parse roxygen comments into rd files and output then into the "./man" directory
roc <- roxygen2:::rd_roclet()
results <- roxygen2:::roc_process(roc, parsed, mydir)
roxygen2:::roc_output(roc, results, mydir, options=list(wrap=FALSE), check = FALSE)
现在，您应该在曾经为空的man文件夹中正确格式化myData.Rd和otherData.Rd文件。
roxygen2 现在原生支持此功能，但由于相关函数标记为"内部"，因此它们不会公开给文档索引。
尽管如此，这些函数还是被导出并构成官方 API 的一部分：
-
parse_file -
roclet_process
而且，要显示生成的帮助，您需要
-
tools::parse_Rd -
tools::Rd2txt和tools::Rd2HTML
工作流程如下：
source_env = roxygen2::env_file(sourcefile)
rd_blocks = roxygen2::parse_file(sourcefile, source_env)
help_topics = roxygen2::roclet_process(roxygen2::rd_roclet(), rd_blocks, source_env, dirname(sourcefile))
rd_code = lapply(help_topics, format)
这将为您提供文件中的帮助主题列表。要显示其中一个，您需要 {tools} 包，它是基本 R 的一部分，但默认情况下不附加。
下面显示了文本帮助的显示方法。显示HTML帮助有点复杂（我邀请您阅读并理解utils:::print.help_files_with_topic的源代码，它执行帮助主题的实际显示，并且完全没有文档。
# Display first help topic. In reality you’d want to select a specific one.
topic = names(rd_code)[1L]
help_text = rd_code[[topic]]
rd = tools::parse_Rd(textConnection(help_text))
packagename = tools::file_path_sans_ext(basename(sourcefile))
helpfile = tools::Rd2txt(rd, out = tempfile('Rtxt'), package = packagename)
helptitle = gettextf('R Help on %s', sQuote(sub('\.Rd$', '', topic)))
file.show(helpfile, title = helptitle, delete.file = TRUE)
另一种（更简单的）方法是使用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
这是一个从 Rudolph 代码包装@Konrad泛型函数，可用于生成 .指定文件夹下的 R 脚本的 rd 文件。对于使用具有"非标准"文件夹结构的模块包的项目，这可以是不创建已安装包的文档解决方案。
moxygenise <- function(codepath, manpath) {
apply_at_level <- function(l, f, n, ...) {
## function to apply a function at specified level of a nested list
if (n < 0) {
stop("Invalid parameter - n should be integer >= 0 -- APPLY_AT_LEVEL")
} else if (n==0) {
return(l)
} else if (n == 1) {
return(lapply(l, f, ...))
} else {
return(lapply(l, function(x) {apply_at_level(x, f, n-1)}))
}
}
list.files.paths <- function(path, pattern) {
## function to list absolute path of all files under specified path matching certain pattern
path <- normalizePath(path)
return(file.path(path, list.files(path=path, pattern=pattern)))
}
sourcefiles <- list.files.paths(codepath, "\.R$")
source_envs <- lapply(sourcefiles, roxygen2::env_file)
rd_blockss <- mapply(roxygen2::parse_file, sourcefiles, source_envs)
help_topicss <- mapply(function(rdblock, sourceenv, sourcefile) {
return(roxygen2::roclet_process(
roxygen2::rd_roclet(),
rdblock, sourceenv,
dirname(sourcefile)))},
rd_blockss, source_envs, sourcefiles)
rd_codes <- purrr::flatten(apply_at_level(help_topicss, format, 2))
mapply(function(text, topic, outpath=manpath) {
cat("Write", topic, "to", outpath, "n")
write(text, file=file.path(outpath, topic))
}, rd_codes, names(rd_codes))
return(NULL)
}
指定保存模块源文件的路径以及要生成 的路径。Rd 文件（应该是项目主页/man/，如果你想要帮助功能与你的源包一起工作）
moxygenise('path/of/module/source/', 'path/of/output.Rds')
这是一种有效的黑客方法。在临时目录中创建一个虚拟包，使用它生成Rd文件，然后将Rd文件解压缩出来，并进行清理。请参阅下面的代码。
希望这有帮助。
注意：请确保在要为其生成Rd文件的函数中具有@export标记，以便使其正常工作。
makeRd <- function(rscript, dir.out){
stopifnot(require(devtools))
# Prepare paths
pkg.path = tempdir()
r.path = file.path(pkg.path, 'R')
man.path = file.path(pkg.path, 'man')
desc.path = file.path(pkg.path, 'DESCRIPTION')
# Create directories
dir.create(r.path, F)
dir.create(man.path, F)
# Write dummy description
z = c('Package', 'Type', 'Title', 'Version', 'Date', 'Author', 'Maintainer', 'Description', 'Licence')
writeLines(paste0(z, ': X'), desc.path)
# Copy rscript file over to dummy package and generate rd files
file.copy(rscript, r.path)
suppressMessages( document(pkg.path) )
# Copy generated Rd files to output directory
f.in = list.files(man.path, full.names = T)
f.out = file.path(dir.out, basename(f.in))
for(i in 1:length(f.in)) file.copy(f.in[i], f.out[i], overwrite = T)
# Unlink
unlink(pkg.path, T, T)
return(f.out)
}
# Example
rd = makeRd(rscript='foo.R', dir.out='~/Desktop')
print(rd)
# [1] "~/Desktop/myFunction.Rd"
tools包中有一个名为 parse_Rd 的函数。您可以生成 .Rd 文件，对它们运行parse_Rd，并将输出另存为模块命名空间中的对象。您需要一个新的搜索函数（可能是modHelp），该函数在命名空间中查找适当的 Rd 对象，并使用Rd2text或其他对象或自定义解决方案显示它。不确定除了 Rd2text 吐出的基本文本帮助之外，您是否可以获得任何其他内容，但您可能会。
我的回答是你为什么不把分析放在一个包里？通过这种方式，您可以获得软件包附带的所有零碎支持，包括文档（数据和任何自行编写的函数），并拥有自动知道数据所在位置的小插图（并能够从 R-help 中列出小插图）。你想要一个包的功能，没有包，那只是需要。相反，选择包结构进行分析，并利用它来发挥自己的优势，例如记录数据集。
您评论说包不集成Rnw文件，但我宁愿认为您错了。包vignettes的默认格式是Rnw或Sweave文件。您可以轻松地选择小插图作为制作包装分析报告的一种方式。
我实际上在自己的分析中使用了这种方法，并在几篇博客文章中记录了它：为什么，如何以及与项目模板的比较。我也在学术分析项目（越来越多地这样做，还不能举出一个例子）和个人项目（例如 https://github.com/rmflight/timmysDensity，http://rmflight.github.io/posts/2013/06/timmysDensity.html，注意我还没有使用包机制来查找数据）中使用它。
顺便说一句，除了将数据放入包中（其中有仅数据包，Bioconductor 有相当多的包）之外，我认为除了简单地提供原始roxygen2标签之外，没有办法做到您的要求。R 文件，如上文所述数据集。