11

I am submitting a package to CRAN and I have got the below warning from the reviewers team:

Package has a VignetteBuilder field but no prebuilt vignette index.

that I have in fact seen also when running devtools::release(). I am using the last R version as R version 3.3.1 and have the following .Rmd vignette source:

---
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{<my vignette title>} 
  %\VignetteEngine{knitr::knitr}
  %\usepackage[utf8]{inputenc}
---

Moreover, I have included knitr in the DESCRIPTION file as per default:

Suggests:
    knitr
VignetteBuilder:
    knitr

I have looked around and, although the issue seems to be quite common, I have not been able to understand why the index does not build (and how to force build it).

This question and links therein are the top google results but do not solve the problem.

Community
  • 1
  • 1
gented
  • 1,620
  • 1
  • 16
  • 20
  • Do you have no `title`? And the last line is sometimes `%VignetteEncoding{UTF-8}` or just `\usepackage[utf8]{inputenc}` – J_F Sep 22 '16 at 21:56
  • The title is there (I just didn't include it in the question body) and so is the `%VignetteEncoding{UTF-8}`. I suppose the problem is elsewhere, it must be in the building properties or the like. – gented Sep 22 '16 at 22:13
  • I have had the same answer. What was your solution ? – ClementWalter Dec 23 '16 at 18:22
  • 6
    You might want to check your `.Rbuildignore`. For me the issue was that I had `build` included there, which you should not do. –  Mar 14 '17 at 19:45

1 Answers1

3

This requires a build/vignettes.rds or Meta/vignettes.rds file. This file is automatically generated by devtools. Please make sure that you do not delete it or list it in .Rbuildignore (check for a line containing build Meta or ^build/vignettes.rds$ ^Meta/vignettes.rds$ and delete it from the file).

Tom Kelly
  • 1,458
  • 17
  • 25
  • devtools puts those ignores in there. Are you saying that we should remove every time what devtools puts into Rbuildignore? – Stefano Borini Sep 06 '22 at 15:34