問題タブ [roxygen]

実行時に問題があったかどうかを検出することは可能roxygenizeですか (パッケージ roxygen2)?

パッケージの文書化、チェック、およびビルドのプロセスを自動化したいのですが、文書化がうまくいかない場合は停止したいと考えています。

roxygenize のヘルプには、戻り値が NULL であると表示され、stackoverflow を検索しても成功しませんでした。現在、出力を見て、「エラー」で始まる行があるかどうかを検索する必要があります。

どんなヒントでも大歓迎です！

for ループを持つ R スクリプトに基づいて、knitr を使用して HTML レポートを生成しようとしています。forループ内のコメントからマークダウンコメントを生成したいのですが、可能かどうかわかりません。

簡単な例を次に示します。これは test.R にあります。

次に、spin を使用して Rmd ファイルを生成します: spin('test.R')

ただし、Rmd ファイルは次のようになります。

R チャンク内のマークダウン コメントは HTML にコンパイルされません。出来ますか？

ありがとう、ピーター

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

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

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

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

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

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

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

最小限のケースを示すために、次のパッケージがあるとします。

私がroxygenize（RStudioで、「Build & Reload」の前に）。私は得る：

何がうまくいかないのですか？このエラーを解決するにはどうすればよいですか?

私のセットアップ：

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

パッケージをビルドすると、このエラーが発生します。このエラーを回避するための手順を教えてください。

ビルドを押したときのエラーは次のとおりです。

roxygen2 を使用して参照クラス オブジェクトのドキュメントを作成しようとしていますが、R CMD チェックを実行すると次の警告が表示され続けます。

これは、上記の警告に関連する ref クラスと roxygen2 ブロックです。

生成された R ドキュメントは次のとおりです。

myRefClass-class {testPackaging} R ドキュメント myRefClass クラス

説明

myRefClass の説明

スロット

field1 文字スロット

field2 数値スロット

私が見つけたドキュメンテーションに関しては、codoc が私のコードとドキュメンテーションの間の一貫性をテストしています。私が知る限り、すべてのスロット名は同じです。おそらく私は何かを逃しています。ドキュメントがこれを参照クラスとして自動的にマークする必要があるかどうか、または何らかの方法でそれを示す必要があるかどうかわかりませんか? スロット「.xData は、異常な型からの継承を有効にするために使用される」ことを示す R ドキュメントを見つけましたが、ここで行っていることになぜそれが適用されるのか、またはそれを使用して何かを行う必要があるのか​​ わかりません。

私はroxygenタグの順列をいくつか試しましたが、ここで見つかった構造に近づけることで、R CMDチェックから最良の結果/最小の警告が得られるようです: Roxygen2 - @export reference class generator? roxygen2 を参照クラスで使用する方法の例をネットで調べてきました。間違った場所を探しているのかもしれません。あまり運がありませんでした。

roxygen2 v 3.1.0 / RStudio バージョン 0.98.501 / R バージョン 3.0.3 / OSX 10.9.2 を使用しています (注: roxygen2 v 4.0 へのアップグレードを試みたところ、参照クラスが完全に詰まってしまい、ドキュメントが作成されていませんでした。まったく生成されません）

roxygen2 と参照クラスを使用する CRAN パッケージを知っている人がいれば、それがどのように適切に行われているかを知ることができます。Rでのパッケージ構築は初めてです。

roxygen を使用して独自のパッケージを作成しています。問題を引き起こしている関数があります:

パッケージのスケルトンを (devtools の create(my-package) で) 作成し、document() を使用して roxygen タグを処理しました。ただし、パッケージをインストールしようとすると失敗します。

... *ヘルプ インデックスのインストール ** パッケージ インデックスの構築 ** インストールされたパッケージをロードできるかどうかのテスト エラー: 名前空間 'my-package' のロード中にオブジェクト 'extract' が見つかりません エラー: ロードに失敗しました 実行が停止しました

roxygen は、extract.sig.metadata が S3 メソッド、つまり export() の特殊な形式であると考えていると確信していますが、関数 export() が見つからないため、壊れています。しかし、これは s3 メソッドではなく、単なる extract.sig.metadata という関数です。Rd コードを見ると、/usage タグが奇妙に見えます。

名前をextractSigMetadataに変更すると、問題は技術的に修正され、.Rdコードが変更されます。

しかし、関数の名前を変更する必要はありません (私のパッケージには同じ問題を抱えている関数がたくさんあり、それらは多数のスクリプトで使用されています。名前を変更するのは非常に面倒です)スキーマではない)。

---> これが単なる通常の関数であり、変な s3 メソッドではないことを roxygen に伝える方法を知っている人はいますか? @method タグと関係があると思いますが、これを機能させるのに十分な適切な使用方法がわかりません。ありがとう！！！