r - 使用 roxygen 文档包含图像

Question

是否可以在 roxygen 生成的文档中包含图像？我有许多函数本质上是 ggplot() 的包装器，我想通过显示输出示例来记录它们。

Answer 1

根据 R 2.14 公告的变更列表:

Rd markup has a new \figure tag so that figures can be included in help pages when converted to HTML or LaTeX. There are examples on the help pages for par() and points().

来自:http://cran.r-project.org/doc/manuals/R-exts.html#Figures

要在帮助页面中包含图形，请使用\figure 标记。共有三种形式。

两种常用的简单形式是\figure{文件名}和\figure{文件名}{替代文本}。这将包括 HTML 或 LaTeX 输出中的图形副本。在文本输出中，将显示替代文本。 (当省略第二个参数时，将使用文件名。)文件名和替代文本都将逐字解析，并且不应包含 HTML 或 LaTeX 中重要的特殊字符。

专家形式是\figure{文件名}{选项:字符串}。 (“options:”一词必须完全按照所示方式键入，并且后跟至少一个空格。)在此形式中，字符串将作为 src 属性后面的属性复制到 HTML img 标签中，或者复制到\的第二个参数中。 LaTeX 中的图形宏，默认情况下用作\includegraphics 调用的选项。由于任何单个字符串不太可能满足两种显示模式，因此专家表单通常会包含在条件语句中。作者有责任确保使用合法的 HTML/LaTeX。例如，要在 HTML(使用简单形式)和 LaTeX(使用专家形式)中包含 Logo ，可以使用以下内容:

 \if{html}{\figure{logo.jpg}{Our logo}}
 \if{latex}{\figure{logo.jpg}{options: width=0.5in}}

包含图形的文件应存储在目录 man/figures 中。该目录中扩展名为 .jpg、.pdf、.png 和 .svg 的文件将在安装时复制到 help/figures 目录。 (PDF 格式的图形不会在大多数 HTML 浏览器中显示，但可能是引用手册中的最佳选择。)在\figure 指令中指定相对于 man/figures 的文件名。