时间戳

首页 > 解决方案 > 包文档中的小插图

r - 包文档中的小插图

问题描述

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

按照本网站的建议，我已经使用 重新安装了软件包devtools::install()，确保该目录被调用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 = "#>"
)
```

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

标签： rpackage

解决方案

我有一个解决方案，从这里。安装软件包时，您需要强制安装小插图。

本地包示例：

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

包在 github 上的示例：

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

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

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

推荐阅读