R 检查警告:'vignettes' 目录中有文件,但 'inst/doc' 中没有文件

R check warning: Files in the 'vignettes' directory but no files in 'inst/doc'

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

Files in the 'vignettes' directory but no files in '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'

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

的问题

虽然我不确定,如果这是假定的解决方案,它会使警告消失。

我在 Rmd 插图中遇到了类似的问题。我通过将小插图的 YAML header 更改为如下内容来修复它:

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

在我的例子中,我遇到这个问题是因为我按照@Claudia 的回答指定了我的 YAML,但我在 DESCRIPTION 文件中指定了 rmarkdown 作为 VignetteBuilder。在我的 DESCRIPTION 文件中使用 VignetteBuilder: knitr 解决了这个问题。

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

我不仅在 Win R Development 版本上遇到错误,但对我来说,解决方法是在 [=] 的 Suggests 字段中添加 markdownknitr 14=] 文件。然后,我想包编译器很清楚小插图被指定为 markdown/HTML 文档。 这些行在我的降价 YAML header:

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