問題タブ [roxygen2]

devtools 関数で roxygen2 ドキュメントを使用すると、パッケージ ライブラリ ファイルを特定の順序でロードする必要があるかどうかに関係なく、パッケージの DESCRIPTION にフィールドがdocument自動的に生成されます。Collate:

私は一連の S4 メソッドを含むパッケージに取り組んでおり、それらを使用するメソッドまたは他のクラスの前にクラス定義がロードされていることを確認したいのですが、Collateリストで実行できることは理解していますが、方法がわかりませんこれを roxygen2 ドキュメント形式で示します。

roxygen2のマニュアルではタグについて言及していますが、実際にはドキュメントにコードが含まれているだけのように見えます。たとえば、フラグ@includeを介して外部の例を追加するためです。@examplesこれは、メソッドの照合順序を指定するために使用できますか?

roxygen2 で文書化しようとしている関数があります。

この関数には約 10 の異なるメソッドがあり、それぞれに非常に長い説明があります。使用可能なさまざまなメソッドをすばやく簡単に確認できるように、各「メソッド」の間に改行が必要です。

書かれているように、 を呼び出すroxygenize('mypackage')と、上記のテキストが 1 行に圧縮されます。

roxygen2 ドキュメントに改行を手動で挿入するにはどうすればよいですか?

S4 のドキュメントに roxygen2 を使用していますが、何らかの理由で使用セクションが表示されません。混乱を示すために簡単な例を作成しました。

私は Rstudio を使用して Sweave と R を合理化し、他のアナリストと共有するデータ分析を行っています。変数のコーディングを非常に明確にするために?myData、必要に応じて呼び出して役立つファイルを取得できるように、ヘルプ ファイルのようなものがあると便利です。私は Rd マークダウンが好きで、全体的な要約、変数ごとの変数、探索的分析の実行方法の例など、分析データセットを文書化する大きな可能性を実際に秘めていると思います。

特にパッケージを作成する場合はこれを行うのは簡単ですが、パッケージは最終的に関数のコレクションであり、Rnw ファイルを統合しないため、混乱すると思います。

Roxygen2 を使用して、どのパッケージにも含まれていないデータセットのヘルプ ファイルを作成できますか?

Roxygen のコメントには、行の先頭に#'. 関数の例を書いてテストするとき、コメントのオンとオフを切り替えられると便利です。コードをコピーしてvimに貼り付け、それらのコメントを削除または追加することはできましたが、それはあまりエレガントではありません.

• Rstudioでroxygenのコメントを切り替える簡単な方法はありますか?
• あるいは、roxygen コメント文字によってコメントアウトされたサンプル R コードを効率的に実行する別の方法はありますか?

更新:横方向に考えると、使用@example examples/foo.rは、実際のサンプル コードに Roxygen コメントを使用する必要を回避する代替方法であると思います (つまり、ファイルからサンプルをソースすることにより、つまりexamples/foo.r)。

R パッケージを作成していますが、1 つのファイル内のロジックの一部を、同じファイル内で定義する内部ヘルパー関数に分割すると便利であることがわかりました。関数が を介して使用するヘルパー関数を決定する特殊なケースがありますmatch.fun()。それらは他の機能や人々にとって役に立たないので、これらを別のファイルに入れたくないし、エクスポートしたくありません。

を使用して合格するすべてのテストケースtest_dir()。これらの関数をエクスポートしないと、R CMD チェック中にテストが失敗します。

この投稿を見た後、エクスポート エントリを NAMESPACE に明示的にエクスポートまたは追加すると、動作させることができますが、これらをエクスポートしたくありません。

これを行うためのより良い方法はありますか?エクスポートする必要はありませんか? match.fun()(問題の原因は、実行時に関数を呼び出す他の方法である可能性があり、またその可能性があることを認めます。)

R コード内で roxygen2 コメントを生成しようとしていますが、現在 R プロジェクトを使用しておらず、ProjectTemplate ( http://projecttemplate.net/ ) を使用しています。

私の問題は、roxygen2がプロジェクト内でのみ機能するように見えることです（うまくいけば、これについて間違っています）。したがって、コマンドを実行すると

ファイルが見つからないというエラーが表示されDESCRIPTIONます。DESCRIPTIONファイル を作成してroxygenize('.')再度実行すると、コードが実行され/man、/instフォルダが作成されますが空白になります。

Rプロジェクトの外でroxygen2を使用することさえ可能かどうか誰か教えてもらえますか?

S3 と S4 のメソッドを組み合わせたパッケージがあります (ええ、知っていますが、sort()、as.matrix() などの S4 を作成しようとしています...)。だから私はCRANの古典的なroxygen2（バージョン2.2.2）に固執します

何を試しても、Rd ファイルの使用タグが自動的に入力されないことに気付きました。@usage を使用して手動でそれを行うことができることはわかっていますが、かなり広範なコード ベースがあり、誤ってどこかでタグを見逃したくないので、自動化しておきたいと考えています。

例：

これをパッケージにラップし、roxygen2 (およびそれが重要な場合は RStudio) を使用して roxygenize し、ヘルプ ファイルを確認すると、次のようになります。

\usage セクションが見つかりません...