使用roxygen文档包含图像

问题描述：

是否可以在由roxygen生成的文档中包含图像？我有许多基本上为ggplot（）封装的函数，我想通过显示输出示例来记录这些函数。使用roxygen文档包含图像

只需使用通常的Rd语法 – hadley

如果我能找到它，我就不会问了。我可以找到的唯一全面的语法列表是bioconducter ...并且不包括包含图像的语法。 –

并且还在“编写R扩展”中。 –

答

按照来自R 2.14的公告更改列表：

路标记有一个新的\数字标签使数字可以当转换为HTML或LaTeX列入帮助页面。在上有关于par（）和points（）的帮助页面的示例。

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

要在帮助页面数据，使用\数字标记。有三种形式。

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

专家形式是\ figure {filename} {options：string}。（单词'options：'必须完全按照所示键入，后面至少有一个空格。）在这种形式下，字符串被复制到HTML img标签中作为src属性后面的属性，或者复制到\图LaTeX中的宏，默认情况下用作\ includegraphics调用的选项。由于任何单个字符串都不可能满足两种显示模式，所以专家形式通常会用条件包装。作者应该确保使用合法的HTML/LaTeX。例如，为了包括以HTML标志（使用简单的形式）和胶乳（使用专家形式），下面可以使用：

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

含有附图中的文件应被存储在目录的人/人物。来自该目录的扩展名为.jpg，.pdf，.png和.svg的文件将在安装时被复制到帮助/图形目录。（PDF格式的数据不会在大多数HTML浏览器中显示，但可能是参考手册中的最佳选择。）在\ figure指令中指定相对于man/figures的文件名。

使用roxygen文档包含图像

相关推荐