roxygenによって生成されたドキュメントに画像を含めることは可能ですか?出力の例を示して文書化したい、本質的にggplot()のラッパーである関数がいくつかあります。
1 に答える
R 2.14の発表からの変更リストによると:
Rdマークアップには新しい\figureタグがあり、HTMLまたはLaTeXに変換したときに図をヘルプページに含めることができます。par()とpoints()のヘルプページに例があります。
差出人:http://cran.r-project.org/doc/manuals/R-exts.html#Figures
ヘルプページに図を含めるには、\figureマークアップを使用します。3つの形式があります。
一般的に使用される2つの単純な形式は、\figure{filename}と\figure{filename}{代替テキスト}です。これには、HTMLまたはLaTeX出力のいずれかに図のコピーが含まれます。テキスト出力では、代わりに代替テキストが表示されます。(2番目の引数を省略すると、ファイル名が使用されます。)ファイル名と代替テキストの両方が逐語的に解析され、HTMLまたはLaTeXで重要な特殊文字を含めることはできません。
エキスパートフォームは\figure{filename} {options:string}です。(「options:」という単語は、示されているとおりに正確に入力し、その後に少なくとも1つのスペースを続ける必要があります。)この形式では、文字列はsrc属性に続く属性としてHTML imgタグにコピーされるか、\の2番目の引数にコピーされます。 LaTeXのFigureマクロ。これは、デフォルトで\includegraphics呼び出しのオプションとして使用されます。両方の表示モードで単一の文字列で十分である可能性は低いため、通常、エキスパートフォームは条件付きでラップされます。合法的なHTML/LaTeXが使用されていることを確認するのは作成者の責任です。たとえば、HTML(単純なフォームを使用)とLaTeX(エキスパートフォームを使用)の両方にロゴを含めるには、次のように使用できます。
\if{html}{\figure{logo.jpg}{Our logo}}
\if{latex}{\figure{logo.jpg}{options: width=0.5in}}
図を含むファイルは、ディレクトリman/figuresに保存する必要があります。そのディレクトリの拡張子が.jpg、.pdf、.png、.svgのファイルは、インストール時にhelp/figuresディレクトリにコピーされます。(PDF形式の図はほとんどのHTMLブラウザーでは表示されませんが、リファレンスマニュアルでは最良の選択である可能性があります。)\figureディレクティブでman/figuresに関連するファイル名を指定します。