問題タブ [roxygen2]

パッケージの Depends ではなく Imports に RSQLite パッケージを追加しようとしています。説明には次のものがあります。

NAMESPACE には次のものがあります。

しかし、パッケージをロードすると失敗します:

dbDriverはメソッドによってエクスポートされますがRSQLite、RSQLite名前空間がロードされていないため、これは失敗した例になります。を追加しようとしまし@importMethodsFrom RSQLite dbDriverたが、結果は同じです。

次に何を試せばいいですか？

を使用するRパッケージがありますroxygen2。にはいくつかのCコードが/srcあり、私は で作業を始めたばかりDoxygenです。ドキュメントを結合したり、コンパイルを roxygen2 と統合したりする方法はありますか? Cコード ドキュメントを配置する場所に関する「ベスト プラクティス」はありますか?

roxygen2 と doxygen のグーグル検索は、主に roxygen につながり、 doxygen の結果と同様です。Doxyfiles を含むいくつかのパッケージを見つけましたが、一貫した構成はありません。たとえば、ソース ディレクトリの外部にあるフォルダーlme4に出力します。Matrix のルート ディレクトリにも Doxyfile があります (ただし、以前のリリースでは にありました。このドキュメントは、パッケージ ディレクトリの外にもエクスポートされます。inst/doc/Doxyfiledoxygenlme4inst

パッケージ内にドキュメントを含めない理由はありますCか? または、Doxygen が広く使用されているにもかかわらず、R パッケージ内であまり使用されないのはなぜCですか?

更新:関連するroxygen2 機能のリクエストを参照してください

私は、それぞれ約 50 行のドキュメントを含む約 120 個のファイルを含む非常に大きなプロジェクトを持っています。Roxygen2 は私のコードを文書化するための命の恩人ですが、壊れた文書を修正する際にいくつかの手に負えない問題に遭遇しました。Rstudio から roxygenise を実行すると、次のエラーが発生します。

メッセージはかなり明確ですが、どのファイルから発信されたのかは明確ではありません。プロジェクトには 500 を超えるファミリ タグがあるため、それらを手動で検索するのは簡単ではなく、長期的な解決策ではありません。

roxygen エラーを特定のファイルにローカライズする方法はありますか? ループ内の各ファイルを roxygenate することでこれが可能になると思いますが、これを行う方法がわかりませんでした。

ヘルプ、扇動、またはスクリプトをいただければ幸いです。説明が必要な場合は、下にコメントを残してください。

パッケージのファイルに2 つのオブジェクト (page.heightとpage.width) があります。私はこのようsysdata.rdaにそれらを文書化しましたroxygen2

page.heightオブジェクトはエクスポートされますが、オブジェクトはエクスポートされませpage.widthん。両方が同じヘルプファイルにエクスポートされて文書化されるようにするには、これをどのように文書化すればよいですか?

パッケージが でインストールされていることがわかりますがlibrary()、ライブラリからパッケージをロードすると、関数を呼び出すことができません。

この質問は、こちらの RStudio ヘルプ ページで別のユーザーから尋ねられましたが、回答がありません。

基本的に、私はすべての手順を実行しました：

(1) Xcodeのインストール

(2) コマンドラインツールのダウンロードとインストール

(3) インストールされた MacTex

(4) R パッケージとそれに付随する記述ファイルを含むディレクトリを選択します。

このパッケージは、私が最初にビルドに使用した Mac で問題なくコンパイルされました。ただし、ビルド ディレクトリに記述されているにもかかわらず、RStudio が DESCRIPTION ファイルを検出できないというメッセージが表示されます。スクリーンショットを添付しました。

私が得るエラーメッセージは次のとおりです。

私が欠けているものを知っている人はいますか？参照用にスクリーンショットを添付しました。完全な開示: これは商用アプリケーションの作業です。

たとえば、最小限の作業例として、次のパッケージをビルドしたとしますTest。

そして今、私は次のように変更setClassしsetRefClassます:

（RStudioで）「ビルドとリロード」を実行すると、エラーが発生します

もちろん、まだリファレンス クラスではありませんが、更新されたパッケージではリファレンス クラスになります。古いクラス定義をチェックしても、奇妙な警告が表示されます。

Roxygen は私の新しい定義を無視しているようCで、古いクラス定義はまだ有効です。Roxygen を新しい定義に集中させ、再構築を成功させるにはどうすればよいですか?

(この問題は特定のものではないことに注意してくださいsetClass。例として使用しているだけです。)

私のセットアップ：

再構築する前に RStudio で Roxygen をセットアップして実行し、@exports etc が変更された場合に NAMESPACE ファイルが自動的に更新されるようにします。

• Roxygen2 3.0.0
  • roxygen を使用して生成します (RStudio で):
    • Rd ファイル
    • 照合フィールド
    • 名前空間ファイル
  • 実行時に自動的に roxygenising (RStudio で):
    • R CMD チェック
    • ソースおよびバイナリ パッケージのビルド
    • ビルド＆リロード
• R: 3.0.2 (フリスビーセーリング)
• IDE: RStudio 0.98.490
• OS: Windows 8.1

タグをコメントアウトしたいとし#' @exportます - 文書化された方法は何ですか?

(標準の R コメントと同様に) 前にa を追加して#もうまくいかないようです:それでも私のファイルに##' @export fooつながります。export(foo)NAMESPACE

RStudio で roxygen セクション全体をブロックコメントアウトすることもできますか?

たとえば、次のパッケージが呼び出されていて、TestクラスをエクスポートしたいとしますA。

Aただし、ビルドしてロードした後、のジェネレーターを使用すると、次のエラーが発生します。

NAMESPACEファイルの内容に問題がないことを確認しました。

それで、何がうまくいかないのですか？クラス ジェネレータがエクスポートされないのはなぜですか?