在 R 包文档 (.Rd) 文件中包含图像
Including images in R-package documentation (.Rd) files
我正在努力在我的包中记录可视化功能。为此,我想通过 Rd 文件 'funcname.Rd' 嵌入一个图像,它可以解释函数中使用的各种参数,如果用户去阅读包手册 PDF 或写入 '?funcname,它会弹出' 在 R 中。行中的内容:
'Writing R extensions'-文档似乎没有解决这个问题,我能找到的唯一参考文献是 this blog post and this R-devel discussion。前者有一个损坏的 link 到一个名为 'base64' 的包,而后者只解决各种替代方案,例如将图像包含在 R 包小插图中。如果这可以与 CRAN 兼容,那就太好了。
如有任何关于如何解决此问题的建议,我们将不胜感激,谢谢!
未经测试,但查看 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。
我正在努力在我的包中记录可视化功能。为此,我想通过 Rd 文件 'funcname.Rd' 嵌入一个图像,它可以解释函数中使用的各种参数,如果用户去阅读包手册 PDF 或写入 '?funcname,它会弹出' 在 R 中。行中的内容:
'Writing R extensions'-文档似乎没有解决这个问题,我能找到的唯一参考文献是 this blog post and this R-devel discussion。前者有一个损坏的 link 到一个名为 'base64' 的包,而后者只解决各种替代方案,例如将图像包含在 R 包小插图中。如果这可以与 CRAN 兼容,那就太好了。
如有任何关于如何解决此问题的建议,我们将不胜感激,谢谢!
未经测试,但查看 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。