タグ付けされた質問 「roxygen2」

roxygen（2）を使用してクラスをドキュメント化する場合、タイトルと説明/詳細の指定は、関数、メソッド、データなどの場合と同じように見えます。ただし、スロットと継承は独自の動物です。roxygen2でS4クラスを文書化するための現在または計画中のベストプラクティスは何ですか？ 適当な注意： @slotroxygenの初期の説明でタグの言及を見つけました。 2008年のR-forgeメーリングリストの投稿 は、これが@slot無効であり、roxygenでのサポートがないことを示しているようです。 これはroxygen2に当てはまりますか？前述の投稿では、ユーザーは代わりにLaTeXマークアップを使用して独自の項目別リストを作成することを推奨しています。たとえば、クラスを拡張する新しいS4クラスは、次の"character"ようにコーディングおよびドキュメント化されます。 #' The title for my S4 class that extends \code{"character"} class. #' #' Some details about this class and my plans for it in the body. #' #' \describe{ #' \item{myslot1}{A logical keeping track of something.} #' #' \item{myslot2}{An integer specifying something else.} #' …

306 class  r  s4  slot  roxygen2 

現在、Bing Maps Keyに依存するジオコーディング関数を作成しています。明らかに私は私のものを公開したくない、そして例はそれなしでは失敗する。 ユーザーが手動で実行するためのサンプルをどのように含めR CMD checkますか？

93 r  roxygen2 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する をR使用するパッケージがありますroxygen2。にはいくつかのCコードが/srcあり、私はDoxygenでの作業を始めたところです。ドキュメントを組み合わせる方法、またはコンパイルをroxygen2と統合する方法はありますか？Cコードドキュメントを配置する場所の「ベストプラクティス」はありますか？ roxygen2とdoxygenのグーグルは主にroxygenにつながり、doxygenの結果と似ています。Doxyfilesを含むパッケージをいくつか見つけましたが、一貫した組織がありません。たとえば、lme4は、ソースディレクトリの外部inst/doc/Doxyfileと呼ばれるフォルダーに出力します。MatrixのルートディレクトリにもDoxyfileがあります（以前のリリースではにありました。このドキュメントもパッケージディレクトリの外にエクスポートされます）。doxygenlme4inst Cパッケージ内にドキュメントを含めない理由はありますか？または、広く使用されているにもかかわらず、Rパッケージ内でDoxygenがあまり使用されないのはなぜCですか？ 更新：関連するroxygen2機能リクエストを参照

91 c  r  documentation  doxygen  roxygen2