Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Respect CRAN recommendations for images #280

Closed
hadley opened this issue Mar 13, 2017 · 4 comments
Closed

Respect CRAN recommendations for images #280

hadley opened this issue Mar 13, 2017 · 4 comments
Labels
feature a feature request or enhancement home 🏠

Comments

@hadley
Copy link
Member

hadley commented Mar 13, 2017

If the images are also used for vignettes or Rd files, you can put them
in the 'vignettes' or 'man/figures' directories. Otherwise, please put
them in the top-level 'tools' directory, or a subdirectory of it.

This probably means we should copy all files with common image extensions from those directories.

@hadley hadley added feature a feature request or enhancement home 🏠 labels Mar 14, 2017
@hadley
Copy link
Member Author

hadley commented Mar 19, 2017

All files in vignettes and man/figures are now copied; I think this just means we should tweak the location of any relative image links on the homepage:

  • vignettes/x.png -> articles/x.png
  • man/figures/x.png -> reference/figures/x.png

@hadley hadley closed this as completed in d9e5b16 Mar 19, 2017
nacnudus added a commit to nacnudus/unpivotr that referenced this issue Jul 3, 2017
sfirke added a commit to sfirke/janitor that referenced this issue Jan 11, 2018
ranghetti added a commit to ranghetti/sen2r that referenced this issue Mar 30, 2018
@IndrajeetPatil
Copy link
Contributor

IndrajeetPatil commented Mar 30, 2018

@hadley I created a webpage for my package with pkgdown and, as recommended, all my figures from man/figures/x.png are getting copied to reference/figures/x.png (https://github.com/IndrajeetPatil/ggstatsplot/tree/master/docs/reference/figures) when I run pkgdown::build_site().

But the resulting website still doesn't display any of the images:
https://indrajeetpatil.github.io/ggstatsplot/

What can I change to display the images properly?

@hadley
Copy link
Member Author

hadley commented Mar 30, 2018

@IndrajeetPatil please open a new issue, and include links to the source readme and generated index.html in github

@IndrajeetPatil
Copy link
Contributor

Done! Thanks.

charlieccarey added a commit to charlieccarey/monarchr that referenced this issue Apr 4, 2018
If we know the image will be used in vignette or Rd files, we might put them in man/figures or reference/figures and it'll get copied to the appropriate place in a cran style safe way. See r-lib/pkgdown#280
michaelweylandt added a commit to DataSlingers/ExclusiveLasso that referenced this issue Oct 23, 2018
- Change location of README generated
  files to get them picked up by
  pkgdown

  See r-lib/pkgdown#280
adamhsparks referenced this issue in ropensci-archive/bomrang Mar 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement home 🏠
Projects
None yet
Development

No branches or pull requests

2 participants