在R-package文档(.Rd)文件中包含图像

Tee*_*ala 9 documentation visualization r package rd

我正在努力在我的包中记录可视化功能.为此,我希望通过Rd文件'funcname.Rd'嵌入一个图像,它可以解释函数中使用的各种参数,如果用户去阅读包PDF手册或写'?funcname,它会弹出'在R.中的某些内容:

手动示例

"编写R扩展"文档似乎并没有解决这个问题,而我能找到的唯一参考文献就是这篇博文本次R-devel讨论.前者与一个叫做"base64"的软件包有一个断开的链接,而后者只解决了各种替代方案,比如包括R包装晕影中的图像.如果这可能与CRAN兼容将会很棒.

如何处理这个问题的任何建议将不胜感激,谢谢!

Rom*_*rik 13

未经测试,但是看看GitHub上的R源代码,看起来他们会以下列方式将?par文档添加到文档文件中:

 \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}}
    }
Run Code Online (Sandbox Code Playgroud)

该图似乎保存在/man/figures.

  • 这似乎是目前最好的方法,答案已接受。就我而言,它运行良好,但正如 Roland 在上面的评论中指出的那样,不应期望所有用户都能看到这些数字。 (2认同)
  • 对于将来发生在这个问题上的任何人来说,只是一个FYI.上面指定的语法运行良好! (2认同)