2011-10-05 4 views
14

roxygenによって生成されたドキュメントにイメージを含めることはできますか?私は出力の例を示すことによって文書化したいggplot()の基本的なラッパーであるいくつかの関数を持っています。 R 2.14の発表から変更リストを1としてroxygenのドキュメントを使用したイメージを含める

+0

通常のRd構文を使用してください。 – hadley

+0

見つけられたら、私は尋ねなかったでしょう。私が見つけることができる構文の唯一の包括的なリストは、バイオコンダクターにあった...それはイメージを含むための構文を含んでいなかった。 –

+0

また、 "Writing R Extentions"にも記載されています。 –

答えて

5

:HTMLやLaTeXのに変換されたときの数字は ヘルプページに含めることができるように

Rdのマークアップは、新しい\フィギュアのタグを持っています。 には、par()とpoints()のヘルプページの例があります。 \フィギュアマークアップを使用して、ヘルプページ内の数字を含めることhttp://cran.r-project.org/doc/manuals/R-exts.html#Figures

:から

。 3つの形式があります。

一般的に使用される2つのシンプルな形式は、\ figure {filename}と\ figure {filename} {alternate text}です。これにはFigureのコピーがHTMLまたはLaTeX出力に含まれます。テキスト出力では、代替テキストが代わりに表示されます。 (2番目の引数が省略されると、ファイル名が使用されます)。ファイル名と代替テキストの両方がそのまま構文解析され、HTMLやLaTeXで重要な特殊文字は含まれません。

エキスパートフォームは\ figure {filename} {options:string}です。 ( 'options:'という単語は、表示されているとおりに正確に入力し、少なくとも1つのスペースを続けて入力する必要があります。)この形式では、文字列はHTML imgタグにsrc属性に続く属性として、 LaTeXのFigureマクロ。デフォルトでは\ includegraphics呼び出しのオプションとして使用されます。両方の表示モードで1つの文字列で十分であるとは限りませんので、通常、エキスパートフォームは条件文で囲みます。正当なHTML/LaTeXが使用されていることを確認するのは作者の責任です。例えば、HTML(簡単なフォームを使用)、乳液(専門家のフォームを使用して)の両方でロゴを含めるために、以下を使用することができる:数字を含む

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

ファイルは、ディレクトリの男に格納する必要があります/数字。そのディレクトリの拡張子.jpg、.pdf、.png、.svgを持つファイルは、インストール時にhelp/figuresディレクトリにコピーされます。 (PDF形式の図は、ほとんどのHTMLブラウザでは表示されませんが、参考マニュアルでは最良の選択肢かもしれません。)\ figureディレクティブのman/figureに関連したファイル名を指定します。

関連する問題