32

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

Gustavo B Paterno
  • 976
  • 1
  • 9
  • 14
  • 3
    IMO it's pretty clearly described in the [Writing R Extensions manual](https://cran.r-project.org/doc/manuals/R-exts.html#Writing-package-vignettes): "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." – daroczig Aug 29 '15 at 17:31
  • Thanks! That is correct! Could you add this as a answer? – Gustavo B Paterno Aug 29 '15 at 18:10

3 Answers3

41

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.

daroczig
  • 28,004
  • 7
  • 90
  • 124
10

It is also appropriate to put them in the "man/figures" folder -- this also holds for images you may have in your README.

See comment by Hadley on github issue that happens to reference guidelines: https://github.com/r-lib/pkgdown/issues/280#issue-213905707

Bryan Shalloway
  • 748
  • 7
  • 15
-7

I'm thinking that jpgs would fall under Hadley's advice here

If you want to store binary data and make it available to the user, put it in data/. This is the best place to put example datasets.

pcantalupo
  • 2,212
  • 17
  • 27