Search code examples
rknitrdevtoolsr-package

Which is the correct folder to store images used in vignettes for R packages ?

I am writing a vignette for my R package. I want to include a .jpg image on the .Rmd file that will generate the pdf vignette. The question is: where should I store this image?

I am using the packages devtools and knitr to generate vignettes (following the advise from @hadley book link). Therefore, I have the folder vignettes in my package structure. Should I just include the file there? Or should I include the image on a new folder inside 'inst/images', as suggested for external data used in vignettes (also recomended by @hadley: link)?

Thanks in advance for any suggestion. Cheers

Solution

  • It's pretty clearly described in the Writing R Extensions manual:

    All other files needed to re-make the vignettes (such as LaTeX style files, BibTeX input files and files for any figures not created by running the code in the vignette) must be in the vignette source directory.