使用roxygen文檔包含圖像

Question

是否可以在由roxygen生成的文檔中包含圖像？我有許多基本上爲ggplot（）封裝的函數，我想通過顯示輸出示例來記錄這些函數。

Answer 1

按照來自R 2.14的公告更改列表：

路標記有一個新的\數字標籤使數字可以當轉換爲HTML或LaTeX列入 幫助頁面。在 上有關於par（）和points（）的幫助頁面的示例。

來源：http://cran.r-project.org/doc/manuals/R-exts.html#Figures

要在幫助頁面數據，使用\數字標記。有三種形式。

兩種常用的簡單形式是\ figure {filename}和\ figure {filename} {alternate text}。這將包括HTML或LaTeX輸出中的圖形副本。在文本輸出中，替代文本將被顯示。 （當第二個參數被省略時，將使用文件名。）文件名和替代文本都將被逐字解析，並且不應該包含HTML或LaTeX中重要的特殊字符。

專家形式是\ figure {filename} {options：string}。 （單詞'options：'必須完全按照所示鍵入，後面至少有一個空格。）在這種形式下，字符串被複制到HTML img標籤中作爲src屬性後面的屬性，或者複製到\圖LaTeX中的宏，默認情況下用作\ includegraphics調用的選項。由於任何單個字符串都不可能滿足兩種顯示模式，所以專家形式通常會用條件包裝。作者應該確保使用合法的HTML/LaTeX。例如，爲了包括以HTML標誌（使用簡單的形式）和膠乳（使用專家形式），下面可以使用：

\if{html}{\figure{logo.jpg}{Our logo}} 
\if{latex}{\figure{logo.jpg}{options: width=0.5in}} 

含有附圖中的文件應被存儲在目錄的人/人物。來自該目錄的擴展名爲.jpg，.pdf，.png和.svg的文件將在安裝時被複制到幫助/圖形目錄。 （PDF格式的數據不會在大多數HTML瀏覽器中顯示，但可能是參考手冊中的最佳選擇。）在\ figure指令中指定相對於man/figures的文件名。