【问题标题】:Including an image using roxygen documentation使用 roxygen 文档包含图像
【发布时间】:2011-10-05 18:33:27
【问题描述】:

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

【问题讨论】:

  • 如果我能找到它,我就不会问了。我能找到的唯一完整的语法列表是在 bioconducter... 它不包括包含图像的语法。
  • 还有“写 R 扩展”。
  • 我认为它仅在 2.14 中,这可能是您找不到它的原因。
  • Romain Francois 的非常古老的博客文章描述了要做什么:romainfrancois.blog.free.fr/index.php?post/2010/04/03/…(但这似乎需要一个开发分支 - 我自己无法让它工作)
  • Romain 的方法有点老套。 2.14 即将推出官方支持的方法

标签: r sweave roxygen


【解决方案1】:

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

【讨论】:

  • 如何包含多个选项?
猜你喜欢
  • 1970-01-01
  • 2012-10-31
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2018-10-20
  • 1970-01-01
  • 2019-10-14
  • 1970-01-01
相关资源
最近更新 更多