[Bioc-devel] Vignette warnings/errors

Martin Morgan m@rtin@morg@n @ending from ro@wellp@rk@org
Fri May 11 20:01:23 CEST 2018



On 05/11/2018 01:37 PM, Kenneth Condon wrote:
> Hi all,
> 
> I'm hoping to submit my package soon. But I am having issues with the
> vignette.
> 
> R CMD check results0 errors | 1 warning  | 0 noteschecking files in
> ‘vignettes’ ... WARNING
> Files in the 'vignettes' directory but no files in 'inst/doc':
>    ‘UserGuide.Rmd’, ‘UserGuide.html’, ‘images/benchmark.png’,
>      ‘images/workflow.png’
> Files named as vignettes but with no recognized vignette engine:
>     ‘vignettes/UserGuide.Rmd’
> (Is a VignetteBuilder field missing?)
> 
> 
> BiocCheck FAILED.$error
> [1] "VignetteBuilder listed in DESCRIPTION but not found as
> VignetteEngine in any vignettes:"

I think the deal is that it's VignetteBuilder: in DESCRIPTION, 
VignetteEngine: in the actual vignette; you have VignetteBuilder in the 
vignette.

Martin

> 
> 
> 
> My DESCRIPTION contains:
> RoxygenNote: 6.0.1
> Suggests: knitr,
>      rmarkdown,
>      testthat
> VignetteBuilder: knitr
> 
> My directory tree looks as follows (note there is no inst/doc/ folder):
> data/
> man/
> R/
> tests/testthat/
> vignettes/images/
> 
> Contents of vignettes/:
> images/benchmark.png
> 
> images/workflow.png
> 
> UserGuide.Rmd # created with use_vignette('UserGuide', pkg =
> myNewPackageName)
> Userguide.html # created successfully with knitr button in Rstudio
> 
> 
> Can someone instruct me what I am missing?
> 
> Regards,
> Kenneth
> 
> 	[[alternative HTML version deleted]]
> 
> _______________________________________________
> Bioc-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
> 


This email message may contain legally privileged and/or...{{dropped:2}}



More information about the Bioc-devel mailing list