Roxygenは私の仕事をとても簡単にしてくれて、ほとんどの場合素晴らしくて直感的です。私が理解したことのないことの1つは、@ examplesセクションのインデントを保持してroxygenize("myPackage")、

だろう

それ以外の

細かい部分ですが、最も単純な例を除いてすべてが不必要に読みにくくなるので、誰かが私を助けてくれれば幸いです。

編集：このバグは、roxygenの新しいバージョンで修正されました。

roxygen2開発中のパッケージのデータセットを文書化するために使用しています。roxygen を使用してデータセットを文書化できることは知っていますが、シェーンの答えは最終的にハックを示唆していますが、これは避けたいと思います。だから、私の質問は：

データの roxygen ドキュメントはどこに置くべきですか?

現在、/R フォルダーにanorexia.sub.roxygen拒食症データセットのデータ ドキュメント ファイル ( ) があります。

私が知る限り、それが roxygen2 が検索する唯一の場所だからです。

roxygen2ドキュメントをうまく生成します。しかし、それはanorexia.sub.roxygen.R私のCollateフィールドに追加しますDESCRIPTION:

私の質問は次のとおりだと思います：どうすればroxygen2を手に入れることができますか

1. roxygen ブロックからデータ ドキュメントを自動的に生成し、
2. Collate呼び出しにデータ ドキュメント ファイルを追加しない、および
3. ハックを必要とする解決策を避ける

パラメータ use.Rd2 = TRUE で roxygenize() を呼び出しています。R.oo を使用して単純な S3 オブジェクトを作成するファイル testcase.R があります。ファイルの内容は次のとおりです。ここで roxygen が行うことは何もなく、内容を無視する必要があります。

そして、ここにエラーがあります：

どうすれば警告を消すことができますか? 他の投稿の提案に従って、最初の行として次を追加しましたが、機能しませんでした:

Roxygen2 PDF とこのサイトを読みましたが、@method @S3method @export の違いと、これらを使用して S3 メソッドを適切に文書化する方法について迷っています。議論のために次の例を作成しました。

1. これらを適切に文書化するにはどうすればよいですか？
   
   

2. クラス固有のすべての実装のユース ケースを示す ?print およびその他の汎用関数のドキュメントをエミュレートするにはどうすればよいですか (つまり、?print が「factor」、「table」、「function」の使用法を示す方法)。
   
   

3. wiki ページから: 「すべてのエクスポートされたメソッドには @S3method タグが必要です。@method と同じ形式です。これは、関数ではなくメソッドをエクスポートします。つまり、generic(myobject) は機能しますが、generic.mymethod(myobject) は機能しません。 ."
   私はこれを解釈することはできません。これは、タグが正しく指定されていないと、関数/メソッド呼び出しが正しく機能しないということですか? 具体的にどこが壊れるの？

   MyHappyFunction = function( x , ... ) { UseMethod( "MyHappyFunction" ) }

   MyHappyFunction.lm = 関数( x , ... ) {

   魔法をかける

   }

誰かがRoxygenでR.ooクラス/メソッドを文書化する良い例を教えてもらえますか？R.ooでは、クラス/メソッドはsetConstructorS3（）およびsetMethodS3（）の呼び出しによって作成されるため、それ自体を文書化する関数はありません。標準のRoxygen関数のドキュメントを作成するだけで、NULLステートメントの上に配置しますか？

RoxygenはR内からは正常に機能しますが、コマンドラインから呼び出そうとすると、何らかの理由でRoxygenが機能しなくなります。Windowsの誰かからの同様の苦情に気づきました（このスレッド：R CMD roxygenは認識されません）が、私は現在、nixボックスにいます。ソースからインストールしようとしました（install.packages("roxygen", type="source")）そこにサイコロはありません。

考え？

roxygenによって生成されたドキュメントに画像を含めることは可能ですか？出力の例を示して文書化したい、本質的にggplot（）のラッパーである関数がいくつかあります。

roxygenize()理解できないというエラーが表示されます。roxygen を介して .Rd ファイルが生成されるさまざまな関数のパッケージがあります。

エラーは です。これは、タグError: titlerequires a valueがないことを示しています。@titleただし@title、ファイルにタグがあるkmmisc-package.Rため、何が問題なのかわかりません。

kmmisc-package.R内容:

CRANから再インストールしたばかりのroxygen2 2.1でR 2.13.2を使用しています。完全なものはhttps://gist.github.com/1268056sessionInfo()の要点にあります

編集

@andrieの提案で、私は今持っています

これはまだ同じエラーを生成しています。

私はこの投稿の反対の問題を抱えています。roxygenが\nデフォルトのパラメータ値に導入されているため、RCMDチェックが警告されているようです。

これが私の関数定義です：

そしてここに警告があります：

ここで何かが足りませんか？

私は現在、さまざまなソースからさまざまな変数をゆっくりと蓄積しているプロジェクトに取り組んでいます。やや賢い人なので、メインの「original_data」ディレクトリの下にそれぞれ異なるサブディレクトリを作成し、データの取得元のURLとその他の記述子を含む.txtファイルを含めました。賢くない人なので、これらの.txtファイルには構造がありません。

今、私はすべての異なるデータソースを文書化するメソッドセクションをコンパイルするタスクに直面しています。データを調べて構造を追加したいのですが、ディレクトリをスキャンして情報を抽出するためのレポートツールを見つけるか構築する必要があります。

これはすでにあるようなもののようですProjectTemplateが、私はそこにその機能を見つけることができないようです。

そのようなツールは存在しますか？

そうでない場合、最大限の柔軟性を提供するためにどのような考慮事項を考慮する必要がありますか？いくつかの予備的な考え：

1. マークアップ言語を使用する必要があります（YAML？）
2. すべてのサブディレクトリをスキャンする必要があります
3. （2）を容易にするために、データセット記述子の標準拡張を使用する必要があります
4. 重要なのは、これを最も便利にするために、変数記述子を最終的に使用する名前と一致させる方法が必要です。したがって、変数の名前変更はすべて、クリーニング手順ではなくソースファイルで行う必要があります（理想的とは言えません）、変数名の変更を追跡するためにドキュメントエンジンでコード解析を行う必要があります（うーん！）。変数の名前変更をマークアップファイルで指定できるようにするなど、より単純なハイブリッドを使用する必要があります。
5. 理想的には、レポートもテンプレート化され（たとえば、「[日付]に[dset]データセットから[var]変数を取得しました。」）、Sweaveにリンクされる可能性があります。
6. ツールは、過度の負担にならないように十分な柔軟性を備えている必要があります。これは、最小限のドキュメントが単にデータセット名になることを意味します。