如何使用“roxygen2”在 R function 文档中包含图像？

Question

I write an R package and I want to include some images in some of the function documentations. For documenting the functions I use roxygen2 .

Since roxygen2 handles Markdown very well, I saved the image in the Rd directory and tried to include it like this (within a @param tag):

![](my_image.png)

When I build the function documentation, it looks like this:

It seems, as if the inclusion worked in principal, but the image is not found.

I also tried to store the image in inst/extdata/images/my_image.png and to include it like this:

![](`r system.file(package = "my_package", "extdata", "images", "my_image.png")`)

This did not work either.

So, where do I have to put the images to make them available and how can I include them in the function documentation?

Answer 1

You have to put your image in the folder man/figures and type such an Roxygen code:

#' \if{html}{Here is my figure:
#'
#'   \out{<div style="text-align: center">}\figure{myfigure.png}{options: style="width:750px;max-width:75\%;"}\out{</div>}
#'
#' }
#' \if{latex}{Here is my figure:
#'
#'   \out{\begin{center}}\figure{myfigure.png}\out{\end{center}}
#'
#' }