Including images in R-package documentation (.Rd) files

Question

I am working to document a visualization function in a package of mine. For this purpose I would like to have an image embedded through the Rd-file \'funcname.Rd\' that coul

Answer 1

Untested, but look at the R source on GitHub, it would appear they add an image to ?par documentation file in the following manner:

 \item{\code{mai}}{A numerical vector of the form \code{c(bottom,
        left, top, right)} which gives the margin size specified in
      inches.\cr
      \if{html}{\figure{mai.png}{options: width="35\%" alt="Figure: mai.png"}}
      \if{latex}{\figure{mai.pdf}{options: width=7cm}}
    }

The figure appears to be saved in /man/figures.

For more details see the Writing R Extensions section on the topic.