Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

fix readme images #48

Closed
sckott opened this issue Mar 13, 2017 · 0 comments
Closed

fix readme images #48

sckott opened this issue Mar 13, 2017 · 0 comments
Milestone

Comments

@sckott
Copy link
Contributor

sckott commented Mar 13, 2017

It was recently pointed out to us that some README.html files (generated
from the corresponding README.md ones) on the CRAN package web pages are
incomplete, missing 'local' images not available from the web page and
in most cases actually not even shipped with the package. This clearly
should be changed, so we will move to using '--self-contained' for the
pandoc conversion to ensure that the README.html files are "complete".

Of course, this implies that all 'local' images used in README.md are
needed in the package sources.

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.

The CRAN incoming checks in r-devel were changed to perform the pandoc
conversion checks with '--self-contained', and hence will warn about
missing images.

Pls ensure completeness in the next regular update of your package.


$`/data/rsync/PKGS/rbison/README.md`
[1] "inst/readmeimg/unnamed-chunk-7-1.png"
[2] "inst/readmeimg/unnamed-chunk-10-1.png"
[3] "inst/readmeimg/unnamed-chunk-13-1.png"
[4] "inst/readmeimg/unnamed-chunk-14-1.png"
[5] "inst/readmeimg/unnamed-chunk-15-1.png"
[6] "inst/readmeimg/unnamed-chunk-19-1.png"
@sckott sckott modified the milestone: v0.5.4 Apr 10, 2017
@sckott sckott closed this as completed in f73bccd Apr 10, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant