包括使用roxygen文档的图像

时间:2011-10-05 18:33:27

标签: r sweave roxygen

是否可以在roxygen生成的文档中包含图像?我有很多函数,基本上是ggplot()的包装器,我想通过显示输出的例子来记录。

1 个答案:

答案 0 :(得分:8)

根据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的文件名。