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

Question

我写了一个 R package 并且我想在一些 function 文档中包含一些图像。 为了记录我使用roxygen2的功能。

由于roxygen2处理 Markdown 非常好，我将图像保存在Rd目录中并尝试像这样包含它（在@param标记中）：

![](my_image.png)

当我构建 function 文档时，它看起来像这样：

似乎包含原则上有效，但找不到图像。

我还尝试将图像存储在inst/extdata/images/my_image.png并像这样包含它：

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

这也不起作用。

那么，我必须将图像放在哪里才能使它们可用，以及如何将它们包含在 function 文档中？

Answer 1

您必须将您的图像放在文件夹man/figures中并输入这样的 Roxygen 代码：

#' \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}}
#'
#' }