roxygenによって生成されたドキュメントにイメージを含めることはできますか?私は出力の例を示すことによって文書化したいggplot()の基本的なラッパーであるいくつかの関数を持っています。 R 2.14の発表から変更リストを1としてroxygenのドキュメントを使用したイメージを含める
答えて
: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に関連したファイル名を指定します。
- 1. リストアイテムのRoxygenドキュメント
- 2. ListViewを使用したHorizontalScrollView - ドキュメントのバグ? HorizontalScrollViewため
- 3. Jpedalを使用してビジュアルシグネチャを含むPDFドキュメントをレンダリングする
- 4. Ubuntu 2.6.35 oprofileを使用したカーネルプロファイリングのためのvmlinuxイメージ
- 5. C#プロジェクトにドキュメントを含めるには?
- 6. メイクファイルに.hドキュメントを含める方法
- 7. Roxygen:バックスラッシュ( '\')を含むデフォルトパラメータを関数に設定する方法
- 8. MailMessageのLinkedResourcesを使用したドキュメントの埋め込み
- 9. SAP JCo 3.xを使用するためのチュートリアル、マニュアル、ドキュメント
- 10. Pyinstallerを使用したディレクトリを含める
- 11. スプリングを使用したページを含める
- 12. 臨床ドキュメントを解析するためにcTAKESを使用
- 13. Google Localerでドキュメントを表示するためにGoogleViewerを使用
- 14. PowerShellを使用したSharePointドキュメントのアップロード
- 15. イメージを使用するためのapp.yamlの設定方法は?
- 16. roxygenのスピードアップ
- 17. Swaggerを使用したSpring REST APIドキュメント
- 18. LSA/SVDを使用したドキュメント分類
- 19. 用語の使用API/JSファイルを含めるための定義
- 20. dompdfを使用したpdfイメージのエラー
- 21. パスを使用したイメージのマスキング
- 22. HTML - MFStringとしてSVGイメージを含める
- 23. Swagger APIドキュメントにSwashbuckleを使用してサブクラスを含めるにはどうすればよいですか?
- 24. 生成されたクラスにXMLスキーマのドキュメントのJavadocを含める方法
- 25. doxygenのドキュメントにフォルダを含めるには?
- 26. DjangoのORM Extra()を使用して重複テーブルを含める
- 27. イメージを含める方法、web2pyのデフォルトのビューフォルダにあるスクリプト
- 28. libMagickを使用したクロップgifイメージ
- 29. イメージEmguCv 3.0を使用したStiching
- 30. ダイアログの機能を使用するために含めるJSファイル
通常のRd構文を使用してください。 – hadley
見つけられたら、私は尋ねなかったでしょう。私が見つけることができる構文の唯一の包括的なリストは、バイオコンダクターにあった...それはイメージを含むための構文を含んでいなかった。 –
また、 "Writing R Extentions"にも記載されています。 –