是否可以在 roxygen 生成的文档中包含图像？我有许多函数本质上是 ggplot() 的包装器，我想通过显示输出示例来记录这些函数。
问问题
1288 次
1 回答
13
根据 R 2.14 公告中的更改列表：
Rd 标记有一个新的 \figure 标签，因此当转换为 HTML 或 LaTeX 时，图形可以包含在帮助页面中。par() 和 points() 的帮助页面上有示例。
来自：http ://cran.r-project.org/doc/manuals/R-exts.html#Figures
要在帮助页面中包含图形，请使用 \figure 标记。有三种形式。
两种常用的简单形式是 \figure{filename} 和 \figure{filename}{alternate text}。这将包括 HTML 或 LaTeX 输出中的图形副本。在文本输出中，将显示替代文本。（省略第二个参数时，将使用文件名。）文件名和替代文本都将逐字解析，并且不应包含在 HTML 或 LaTeX 中重要的特殊字符。
专家形式是 \figure{filename}{options: string}。（单词 'options:' 必须完全按照所示输入，并且后跟至少一个空格。）在这种形式中，字符串被复制到 HTML img 标记中作为 src 属性之后的属性，或复制到 \ 的第二个参数中LaTeX 中的图形宏，默认情况下用作 \includegraphics 调用的选项。由于任何单个字符串都不太可能满足两种显示模式，因此专家表单通常会包含在条件句中。由作者确保使用合法的 HTML/LaTeX。例如，要在 HTML（使用简单表单）和 LaTeX（使用专家表单）中包含徽标，可以使用以下内容：
\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 的文件名。
于 2011-10-31T12:50:46.947 回答