R 软件包文档中的小插曲

我为我的一个R软件包写了一个小插曲。它使用

devtools:：build（）

和RStudio中内置的工具（选择了vignettes选项）构建，没有任何错误。html输出文件位于

vignettes

目录中，但它不会显示在

vignette（all=T）

打印的列表中，并且用户指南、包vignettes和其他文档链接不会添加到文档中

按照网站上的建议，我已经使用

devtools:：install（）

重新安装了该软件包，确保目录名为

vignettes

，并检查vignettes是否排除在

.Rbuildignore

中（它包含

^.*.Rproj$

和

^\.Rproj\.user$

）

这是Rmd文件的（匿名）头：

---
title: "Introduction to my package"
author: "John Doe"
date: "May 23, 2021"
output: rmarkdown::html_vignette
bibliography: ../inst/REFERENCES.bib
vignette: >
  %\VignetteIndexEntry{Introduction to my package}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = F}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

是否有其他需要修改的设置？

我有一个解决方案，来自。 在安装软件包时，需要强制安装vignette

本地包的示例：

remotes::install_local(build_vignettes = TRUE, force = TRUE)

包位于github上的示例：

remotes::install_github('account/repository', build_vignettes = TRUE, force = TRUE)

force=TRUE

之所以出现在这里，是因为我们已经有了最新版本的软件包和force安装

---

我打赌您可以在Rstudio中设置此选项，但尚未找到。

vignettes中是否有.Rmd文件？在我的记忆中，源文件在vignettes中，每次构建包时都会编译它。@Gowachin是的，Rmd文件在vignettes中。正如我在问题中提到的，html文件确实是编译好的，并放在了vignette中。问题是R没有列出vignette，也没有在包文档中，也没有使用

vignette（）

函数。嗯……我认为这在我的包中起作用，但我有同样的问题……但是

{pkgdown}

在构建文档时设法找到它。我使用了

devtools

而不是

remotes

，即

devtools:：install\u github（'account/repository'，build\u vignettes=TRUE，force=TRUE）

。但它奏效了。谢谢。是的，devtools和remotes是非常相似的软件包，您可以使用它们来安装本地或开发软件包。