R 检查警告：“vignettes”目录中有文件，但“inst/doc”中没有文件

Question

最近，在进行 cran 检查时，我在 Win R 开发版本上收到了关于我的小插图的警告。

“vignettes”目录中有文件，但“inst/doc”中没有文件

此警告仅在 Win Dev 版本中出现。 对于 Mac、AppVeyor 和 Travis，不会出现警告。

问题是，我不知道警告想告诉我什么。 据我所知，我不必将文件放入 inst/doc 中。

以下是完整的警告消息：

Files in the 'vignettes' directory but no files in 'inst/doc':
'Figures.d/Rlogo.png', 'Figures.d/distribution.pdf',
'Figures.d/distributionbar.pdf', 'Figures.d/gapsize.pdf',
'Figures.d/imputations.pdf', 'Figures.d/imputations2.pdf',
'Figures.d/sponsorlogo.jpg', 'Figures.d/statsna.png',
'Figures.d/tsairgap.png', 'Introduction.pdf', 'Introduction.tex',
'RJournal.sty'

Answer 1

就我而言，我遇到这个问题是因为我已按照 @Claudia 的答案指定了 YAML，但我已在描述文件中指定

rmarkdown

作为 VignetteBuilder。在我的描述文件中使用

VignetteBuilder: knitr

解决了问题。

Answer 2

我对 Rmd 小插图也有类似的问题。我通过将小插图的 YAML 标头更改为如下所示来修复此问题：

---
author: "Name Surname"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteEngine{knitr::knitr}
  %\VignetteIndexEntry{Title of your vignette}
  %\usepackage[UTF-8]{inputenc}
---

Answer 3

我解决了将 Vignette 的 .pdf 输出添加到 inst/doc 的问题

虽然我不确定，但这是否是所谓的解决方案，它使警告消失了。

Answer 4

我不仅在 Win R 开发版本上遇到了错误，但对我来说，修复方法是在

markdown

文件的

knitr

字段中添加

Suggests

和

DESCRIPTION

。然后，我想包编译器很清楚该插图被指定为 markdown/HTML 文档。 这些行位于我的 Markdown YAML 标头中：

output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Example for estimating the case fatality ratio}
  %\VignetteEngine{knitr::knitr}
  \usepackage[utf8]{inputenc}

Answer 5

usethis::use_vignette()

用于小插图创建将解决这个问题。

Answer 6

在编译 R 包期间，会生成这些文件并导致出现问题。 您应该安装 gitignore 软件包，然后在主文件夹中创建一个名为“.gitignore”（无扩展名）的文本文件，并添加要忽略的文件的地址。例如，vignettes/*.pdf