在由roxygen生成的文档中包含图像是否可行？我有很多函数本质上是ggplot()的包装器，我想通过展示输出示例来记录它们。
使用roxygen文档添加图片
20
- Brandon Bertelsen
6
如果我能找到它，我就不会问了。我能找到的唯一全面的语法列表是在bioconducter上...但它没有包括包含图像的语法。 - Brandon Bertelsen
还有在“编写R扩展”中。 - Brandon Bertelsen
1我认为这只存在于2.14版本，这很可能是你找不到它的原因。 - hadley
1Romain Francois写的一篇非常古老的博客文章，介绍了如何在Rd文档中嵌入图像：http://romainfrancois.blog.free.fr/index.php?post/2010/04/03/embed-images-in-Rd-documents（但这似乎需要一个开发分支 - 我自己无法使其工作）。 - Andrie
1Romain的方法有点像黑客技巧。很快就会在2.14中推出正式支持的方法。 - hadley
@hadley 你是从哪里得知的？（链接？） - Brandon Bertelsen
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 中 \Figure 宏的第二个参数中，默认情况下用作 \includegraphics 调用的选项。由于任何单个字符串都不可能同时适用于两种显示模式，因此专家形式通常会被包装在条件语句中。作者需要确保使用合法的 HTML/LaTeX。例如，要在 HTML（使用简单形式）和 LaTeX（使用专家形式）中包含徽标，则可以使用以下内容：
包含图形的文件应存储在man/figures目录中。在安装时，该目录中扩展名为.jpg、.pdf、.png和.svg的文件将被复制到help/figures目录中。(PDF格式的图形在大多数HTML浏览器中无法显示，但在参考手册中可能是最好的选择。) 在\figure指令中相对于man/figures指定文件名。
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 中 \Figure 宏的第二个参数中，默认情况下用作 \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指定文件名。
- Brandon Bertelsen
1
1我该如何包含多个选项？ - SeGa
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接