从 GitHub 上的 R package 下载小插图（Rmd）？

Question

我正在尝试从 GitHub 上的私有存储库安装GitHub 。 Package 对象（例如data和functions ）已按应有的方式下载，但我缺少vignettes ，即位于.Rmd的/vignettes文件夹中的 .Rmd。

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

我的目标是能够使用install_github()从 package 下载functions 、 data和.Rmd 。

Ideally, the functions and data from the package would be in the RStudio memory (which works fine), while the .Rmd file should be downloaded locally to the directory I'm in when I download the package.

目的是使用户可以轻松地使用包含的data和functions重新运行分析（ .Rmd ）。

这是可能的还是我误解了 function？

Answer 1

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

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"), ".")

如果您愿意，可以在 package 中包含 function 来执行此操作。 您还可以实际打开源文件本身的编辑 window

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

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