从 GitHub 上的 R 包下载小插图 (Rmd)？

Question

我正在尝试从 GitHub 上的私有存储库安装 R 包。 data 和 functions 等包对象已按应有的方式下载，但我缺少 vignettes，即位于 [=17] 中的 .Rmd =] 包的文件夹。

library(devtools)
devtools::install_github("person_name/repo_name", build_vignettes = TRUE, auth_token =  "xxx")

我的目标是能够使用 install_github().

从包中下载 functions、data 和 .Rmd

理想情况下，包中的 functions 和 data 将位于 RStudio 内存中（工作正常），而 .Rmd 文件应下载到本地目录 I在我下载包的时候。

目的是为了方便用户重新运行分析（.Rmd），其中包含data和functions。

这是可能的还是我误解了函数？

Answer 1

插图不存储在本地工作目录中。它们存储在包本身中。您通常使用

访问它们

vignette("topicname", package="packagename")

如果你想得到那个RMD文件的路径（假设源文件是一个markdown文件，并不是所有包都是这样），你可以写一个小助手

get_vignette_source_path <- function(...) {
   v <- vignette(...)
   file.path(v$Dir, v$File)
}

例如 dplyr“colwise”帮助

get_vignette_source_path("colwise", package="dplyr")

您也可以让它将文件复制到您的工作目录

file.copy(get_vignette_source_path("colwise", package="dplyr"), ".")

如果您愿意，可以在包中包含一个函数来执行此操作。您还可以使用

为源文件本身实际打开一个编辑 window

edit(vignette("colwise", package="dplyr"))

然后用户可以将该值保存在他们喜欢的地方。

Download vignettes (Rmd) from R package on GitHub?