时间戳

首页 > 解决方案 > 从 GitHub 上的 R 包下载小插图（Rmd）？

r - 从 GitHub 上的 R 包下载小插图（Rmd）？

问题描述

我正在尝试从GitHub. 包对象，例如data和functions，按应有的方式下载，但我缺少vignettes，即.Rmd位于/vignettes包文件夹中的 。

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

我的目标是能够同时下载functions，data以及.Rmd使用install_github().

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

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

这是可能的还是我误解了这个功能？

标签： rgithubdevtoolsr-package

解决方案

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

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

如果您想获取该 RMD 文件的路径（假设源文件是一个降价文件，并非所有包都如此），您可以编写一个小助手

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

如果你愿意，你可以在你的包中包含一个函数来做到这一点。您还可以实际打开源文件本身的编辑窗口

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

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

推荐阅读