[R-pkg-devel] README.html doesn't show figures in CRAN web

[Duncan Murdoch]

On 20/09/2021 12:37 p.m., Jose Barrera wrote:
> Hi everyone,
> 
> I have a package at CRAN that includes a README.html which includes two
> figures created by two R chunks in the README.Rmd. Once the package were at
> CRAN, I noticed that
> https://cran.r-project.org/web/packages/mypkg/readme/README.html doesn't
> show the figures. Instead, the usual icon of image not found is displayed.

The rgl package does something similar to you, though it includes the 
.md file instead of the .html.  The output spec is

output: github_document

CRAN processes the .md to produce the display properly.  This also works 
on Github.

You do need to make sure the man/figures directory is included in the 
tarball.  Check your .Rbuildignore file for patterns that might exclude it.

Duncan Murdoch

> 
> Locally, README.html works fine (both figures are shown). I think the
> problem could be that
> https://cran.r-project.org/web/packages/mypkg/readme/README.html doesn't
> find the figure files because I possibly put them in a wrong folder.
> 
> In my Rmd, I set
> 
> knitr::opts_chunk$set(fig.path = "man/figures/README-")
> 
> I can see the folder "figures" is created in "man" but, "figures" folder is
> not in the tar.gz. I didn't notice that before because I didn't get any
> warning nor note.
> 
> In "R packages", section 20.5.2, I can see, they set
> 
> knitr::opts_chunk$set(fig.path = "README-)
> 
> Should I set fig.path = "README-" instead of fig.path =
> "man/figures/README-" even if my html is not for GitHub? Where should I
> place the png figure files created by the Rmd?
> 
> Any thoughts would be greatly appreciated.
> 
> Thanks,
> 
> Jose Barrera
> Statistician, Associate Lecturer
> 
> *IS**Global*
> Barcelona Institute for Global Health - Campus MAR
> Barcelona Biomedical Research Park (PRBB) (Room Hypatia)
> 
> Doctor Aiguader, 88
> 08003 Barcelona, Spain
> Tel. +34 93 2147383
> jose.barrera using isglobal.org
> <https://www.linkedin.com/in/josebarrera>
> Personal website: sites.google.com/view/josebarrera
> www.isglobal.org
> 
> This message is intended exclusively for its addressee and may contain
> information that is CONFIDENTIAL and protected by professional privilege.
> If you are not the intended recipient you are hereby notified that any
> dissemination, copy or disclosure of this communication is strictly
> prohibited by law. If this message has been received in error, please
> immediately notify us via e-mail and delete it.
> 
> DATA PROTECTION. We inform you that your personal data, including your
> e-mail address and data included in your email correspondence, are included
> in the ISGlobal Foundation filing system. Your personal data will be used
> for the purpose of contacting you and sending information on the activities
> of the above foundations. You can exercise your rights to  access to
> personal data, rectification, erasure, restriction of processing, data
> portability and object by contacting the following address: *lopd using isglobal.org
> <lopd using isglobal.org>*. ISGlobal Privacy Policy at *www.isglobal.org
> <http://www.isglobal.org/>*.
> 
> 
> -----------------------------------------------------------------------------------------------------------------------------
> 
> CONFIDENCIALIDAD. Este mensaje y sus anexos se dirigen exclusivamente a su
> destinatario y puede contener información confidencial, por lo que la
> utilización, divulgación y/o copia sin autorización está prohibida por la
> legislación vigente. Si ha recibido este mensaje por error, le rogamos lo
> comunique inmediatamente por esta misma vía y proceda a su destrucción.
> 
> PROTECCIÓN DE DATOS. Sus datos de carácter personal utilizados en este
> envío, incluida su dirección de e-mail, forman parte de ficheros de
> titularidad de la Fundación ISGlobal  para cualquier finalidades de
> contacto, relación institucional y/o envío de información sobre sus
> actividades. Los datos que usted nos pueda facilitar contestando este
> correo quedarán incorporados en los correspondientes ficheros, autorizando
> el uso de su dirección de e-mail para las finalidades citadas. Puede
> ejercer los derechos de acceso, rectificación, supresión, limitación del
> tratamiento, portabilidad y oposición dirigiéndose a *lopd using isglobal.org
> <lopd using isglobal.org>* . Política de privacidad en *www.isglobal.org
> <http://www.isglobal.org/>*.
>