包装文档中的插图

Question

我为我的 R 包写了一个小插图。它的构建没有任何错误，同时使用 devtools::built() 和 RStudio 内置的工具，并选择了 vignettes 选项。 html 输出文件放在 vignettes 目录中，但它没有出现在 vignette(all = T) 和 用户指南、包插图和其他文档打印的列表中 link 未添加到文档中。

按照 this 站点上的建议，我已经使用 devtools::install() 重新安装了软件包，确保该目录名为 vignettes，并检查了小插图是否被排除在 .Rbuildignore（它包含 ^.*\.Rproj$ 和 ^\.Rproj\.user$）。

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

---
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 = "#>"
)
```

还有其他需要修改的设置吗？

Answer 1

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

本地包示例：

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

包所在的示例 github :

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

force = TRUE是因为我们已经有了最新版本的包，强制安装

我打赌你可以在 Rstudio 中设置这个选项，但还没有找到它。

包装文档中的插图

Vignette in Package Documentation

r

package