构建/安装软件包时,如何告诉R将软件包的插图添加到文档中?

时间:2018-12-27 16:47:46

标签: r devtools vignette

当我在RStudio 1.1.463中使用usethis函数1.4.0.9000和devtools 2.0.1时,我试图添加一个包的插图,并使其显示在其文档中。我用usethis制作了一个新程序包,并设置了许可证,然后添加了一个通用小插图:

setwd("~/Desktop")
usethis::create_package("blah")
usethis::use_gpl3_license("me")
usethis::use_vignette("a-vignette")

我轻轻地调整了小插图,使其结实。我注释掉了库调用,并在小插图的最后一行空白处添加了一些文本:

```{r setup}
#library(blah)
```

Hello World

,然后使用“编织”按钮选中它,然后编织并显示HTML页面。

我使用“构建”选项卡的“更多”菜单,然后选择“文档”,它说:

Updating blah documentation 
Loading blah 
Documentation complete

没有提及小插图。所以我认为这仅在man文件夹中起作用。

然后我使用“构建”菜单的“安装并重新启动”按钮,然后打开程序包文档(在程序包窗口窗格中),其中没有提及任何有关小插图的信息。

所以我尝试使用:

devtools::build_vignettes()

它给了我有意义的反馈:

Building blah vignettes
Moving a-vignette.html, a-vignette.R to doc/
Copying a-vignette.Rmd to doc/
Building vignette index

但是,当我再次安装并重新启动文档时,并没有提及该插图。

那么,如何在其包装文档中将小插图显示为链接?

0 个答案:

没有答案