carloscinelli / benford.analysis

Tools that make it easier to use Benford’s law for data validation and forensic analytics.
61 stars 15 forks source link

Readme file #12

Closed carloscinelli closed 7 years ago

carloscinelli commented 7 years ago

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.

For your information, I attach a list of images used in README.md but missing from the package sources.

Best -k

carloscinelli commented 7 years ago

fixed