在 R 包文档 (.Rd) 文件中包含图像答案

【问题标题】：Including images in R-package documentation (.Rd) files在 R 包文档 (.Rd) 文件中包含图像
【发布时间】：2020-02-22 07:09:32
【问题描述】：

我正在努力在我的一个包中记录一个可视化功能。为此，我希望通过 Rd 文件 'funcname.Rd' 嵌入一个图像，该图像可以解释函数中使用的各种参数，如果用户阅读包手册 PDF 或写入 '?funcname ' 在 R. 中的一些东西：

'Writing R extensions'-document 似乎没有解决这个问题，我能找到的唯一参考资料是this blog post 和this R-devel discussion。前者与一个名为“base64”的包的链接断开了，而后者只解决了各种替代方案，比如将图像包含在 R 包小插图中。如果这可以与 CRAN 兼容，那就太好了。

任何有关如何解决此问题的建议将不胜感激，谢谢！

【问题讨论】：

必须可以将您的 Rd 文件处理为纯文本。我可能更愿意在示例中包含产生这样一个数字的代码。
这大约是他们在 R-devel 讨论中建议的解决方法之一；显然使用'example（funcname）'是人们使用过的东西。 R 生成的图形的问题是，我想在图形中有几条风格化的线条、花括号等来指出不同的参数做了什么，而仅在 R 中这样做可能相当不方便。但你是对的。
请注意，一些（很多？）用户不会看到这个数字。例如，如果他们从命令行工作。

标签： r documentation package visualization rd

【解决方案1】：

未经测试，但查看 GitHub 上的 R 源代码，似乎他们以下列方式将图像添加到 ?par documentation file：

 \item{\code{mai}}{A numerical vector of the form \code{c(bottom,
        left, top, right)} which gives the margin size specified in
      inches.\cr
      \if{html}{\figure{mai.png}{options: width="35\%" alt="Figure: mai.png"}}
      \if{latex}{\figure{mai.pdf}{options: width=7cm}}
    }

该图似乎保存在/man/figures中。

有关更多详细信息，请参阅该主题的Writing R Extensions section。

【讨论】：

谢谢！我去看看。
这似乎是目前最好的方法，答案被接受。就我的目的而言，它运作良好，但就像 Roland 在上面的 cmets 中指出的那样，不应期望所有用户都能看到这些数字。
仅供参考，供将来遇到此问题的任何人参考。上面指定的语法效果很好！