問題タブ [roxygen]

R で関数のドキュメントを作成し、私が使用する外部パッケージを参照する と、インタラクティブな R\code{\link[package]{function}}の関数でうまく機能します。?

しかし、私のpdfファイルには「機能」のテキストがリンクされており、リンクは目次に移動します。これらの PDF へのリンクを無効にするにはどうすればよいですか?

roxygen2 で S4 クラスを文書化しようとしています。私は慎重に文書化したいくつかのスロットと、これらのスロットを拡張するいくつかのサブクラスを持つスーパークラス FacebookGenericCollection を持っています。

サブクラスのコード例を次に示します。

しかし、Rd をビルドすると、「制限」スロットのみが文書化されますが、FacebookGenericCollection クラスから継承された (および文書化された) すべてのスロットは文書化されません。

関数に使用する @inheritParams に似たものを探しています。

@import FacebookGenericCollection を試しましたが、効果はありませんでした。

何か案が？

roxygenドキュメントを再構築 (Ctrl + Shift + D) するのではなく、新しいコメントを追加して生成された新しいドキュメントを見たいときはいつでも、新しい追加内容Build & Reloadがドキュメントに表示されるようにパッケージを変更する必要があります。

ドキュメントのみを再構築すると (Ctrl + Shift + D)、変更を加える前の古いドキュメントがまだ表示されます...

原因となっている設定だと思います。何が原因で、どのように解決することができますか?

プライベート API にアクセスするための小さな便利なパッケージを作成しており、httr関数を使用して要求を実行しています。また、Roxygen を使用してドキュメントなどを処理しています。次httrのような関数をインポートしています。

ただし、プリロードされたパッケージなしでパッケージを実行しようとすると、名前空間エラーが発生します。

私は通常、この種のことについてハドリーの専門知識Dependsを尊重しますが、これはフィールドを使用するだけでなく/ではなく使用する良いケースImportsですか?

編集: Roxygen によって生成された私の名前空間。

編集:私の記述ファイル。

次のような抽象基本クラスがあります。

そして、このクラスを拡張する次のクラス:

走った後

次に、2 つの man ファイルを取得しますが、2 番目のクラスの man ファイルでは、オーバーライドされたクラスの docstring が取得されません。基本クラスの docstring を取得します。私は何か間違ったことをしていますか、それともこれは roxygen2 のバグですか?

また、これを行うより良い方法はありますか？複数行の docstring を使用できるようにしたいと考えています。

プロジェクトに import_packages.r というファイルがあり、次のものが含まれています。

これらdevtools:document()のパッケージは NAMESPACE ファイルに表示されず、実際にはインポートされません。私は何か間違ったことをしていますか？

S3 クラスを含む R コードがいくつかあります。いくつかのメソッドは複数のクラスを処理できます。その詳細を上流クラスのユーザーから隠そうとしています。簡単な例は次のようになります (クラス 2p、3p、3m の場合):

私の問題は、roxygen2 が bar.3m を S3 メソッドとして正しく識別していないことです。@S3method bar.3m と明示的に言うと、roxygen2 は「@S3method は非推奨です。代わりに @export を使用してください」と警告します。roxygen2 に bar.3m が S3 メソッドであることを理解させるにはどうすればよいですか? 注: 実際の関数は自明ではありません。

Roxygen は、C、C++ プログラマーが使用する Doxygen ドキュメンテーション システムに触発されています。私は Doxygen を使用してきましたが、doxygen のコメントさえあれば、どんなプログラムでも文書化するのは本当に簡単だと思います。また、関数とクラスのコール グラフも生成します。roxygen も同じように機能すると思いましたが、roxygen のヘルプを検索すると、R パッケージの文書化に対する解決策しか見つかりません。

Hadley Wickham のオンラインroxygen2 ヘルプを確認しましたが、R スクリプトのドキュメントについては何も説明されていません。

私のスクリプトは 500 ～ 1000 行になることがあり、いくつかの機能があり、常にコメントで文書化しています。グラフ Viz ダイアグラムを含む PDF または HTML ドキュメントを生成したいと考えています。Roxygen はコールグラフとドキュメントのスタンドアロン R スクリプトを作成できますか?

私はroxygenの使い方を学んでいます。rd ビネットでは、"_PACKAGE" を使用してパッケージ ドキュメントを作成していることを示すことを提唱し、「これは pkgname() という関数が既に存在する場合にも機能する」と述べています。

Rパッケージの本を使用するアプローチも見ました

@docType と @name が指定されているのですが、どちらのアプローチでもおもちゃの例を作ろうとすると、期待どおりに動作しません。

おもちゃの例として、「hello()」関数を含む「hello」パッケージを作成したいと思います。

私のhelloパッケージに関するドキュメントを取得することを期待しています

またはおそらく次のようなもの

そして、含まれているhello関数に関するドキュメントを取得することを期待しています

どこが間違っていますか？- roxygen を使用した実装、ドキュメントをクエリしようとしている方法、誤った期待、またはその他の何か?

パッケージ ドキュメントと関数ドキュメントに関する質問は既に確認しましたが、まだ不明な点があります。

私のおもちゃの例についての詳細は次のとおりです。

hello/DESCRIPTION ファイル:

こんにちは/R/こんにちは.R

これで を実行するdocument()と、hello/man/hello.Rd が生成されます。これには、hello パッケージと hello() 関数について私が書いた説明の組み合わせが含まれています。どちらもその.Rdファイルを返します?hello。?hello()

.Rd は次のようになります。