問題タブ [roxygen]

Rのドキュメントは重要ですが、作成/保守にも時間がかかります。誰かがRoxygenをまだ使用しましたか？もしそうなら、それはRパッケージを維持するのに役立ちますか？私は過去にDoxygenを使用しましたが、それらのプロジェクトにはRパッケージに必要なman構造がありませんでした。

ここでビネットを見つけることができます。

roxygen プロセスのパッケージのデータ ディレクトリに .R ファイルを含めることはできますか?

データ ディレクトリにいくつかの .R ファイルを配置しました。データが data() で取得されると、生データ ファイルが読み込まれ、いくつかの変換が実行されます。

パッケージをいじり始めたばかりでroxygen、これまでの結果に非常に満足しています。しかし、私は疑問に思っていましたroxygenが、ユーザーがアクセスできない特定の機能を無視するように指定する方法はありますか？

具体的には、パッケージでフック.Rdを使用しているため、ファイルをポップアップ表示したくありません。.onLoad()この関数はすでにbaseパッケージに文書化されているので、再文書化する理由はありません。

私は他の人が使用する予定のRパッケージを書いているので、これを正しくしようとしています! ドキュメンテーションにroxygenを使用し、単体テストに RUnit を使用したいのですが、使用したことがありません。

これらのツールのいずれかをうまく使用するパッケージは (CRAN または他の場所に) 存在しますか?

関数のパラメーターのデフォルト値には「％」が含まれています。これはroxygenの問題のようです。多くの警告が表示され、ラテックスドキュメントを作成しようとするとRCMDチェックが失敗します。

この関数（およびそのドキュメント）を機能させるにはどうすればよいですか？％の代わりに%%または\％を使用しても効果はありません。

数か月前に、「package.skeleton（）」を使用して.Rdヘルプファイルを生成しました。これらのファイルを編集しました。また、機能を変更したり、一部の機能を削除したり、他の機能を追加したりしました。Rdファイルの更新を自動化する機能はありますか？

アップデート

Rd2roxygenと呼ばれる素敵なパッケージがリリースされたばかりです。これは、作者のYihuiXieがブログで説明しています。

名前が示すように、このパッケージを使用すると、現在.Rdに含まれているドキュメントを.Rファイルにさかのぼって挿入できます。roxygenの学習と、現在開発中のパッケージをRパッケージに変換することの両方にとって有望なアプローチのように思えます。ウーフー。Yihuiに感謝します！

JoshuaとYihuiの回答に基づくと、答えは次のようになります。roxygenを使用すると、ソース.Rコードの変更に基づいてRdファイルなどを自動更新できます。現在roxygenを使用していない場合は、Rd2roxygenを使用すると移行できます。

Roxygenドキュメントをビルドし、パッケージをビルドし、チェックしてから、新しくビルドしたパッケージをマシンにインストールする単純なシェルスクリプトがあります。それは非常に簡単です：

しかし、StackOverflowで前述したように、Roxygenが.onLoad（）関数を取得する際に問題が発生します。解決策は、roxygenizeでuse.Rd2=TRUEオプションを使用することです。コマンドプロンプトからビルドしたいので、この行を変更しました

stdinを介してRへのroxygenizeラインを示す次のラインへ：

これはちょうどダンディに動作するようです。しかし、それは少し複雑に感じます。より簡単でエレガントな方法はありますか？

Roxygenパッケージを試しました。R 内では、Roxygen Vignette の例を実行できます。ただし、コマンド ラインでR CMD roxygenは、有効なコマンドとして認識されません。を実行するR CMD --helpと、すべてのINSTALL, check, ...sweave..., config...コマンド項目が表示されますが、roxygen は表示されません。誰かがこれから私を助けることができますか? 以外に必要な追加のインストール手順はありますinstall.packages("roxygen")か? R 2.12.0 と Rtools 環境で Windows 32 を使用しています。ありがとう。

ここでの優れたSOの回答、およびRoxygenのマニュアルとビネット以外に、Roxygenを使用するための特に徹底的なガイドはありますか？