問題タブ [roxygen2]

これは問題というより煩わしいですが、R のドキュメントがコンパイルされ、行が長すぎるときに発生する行の「オーバーフロー」を防ぐ方法はありますか?

で作成されたいくつかのドキュメントのスニペットR CMD Rd2pdf [options] files:

これについての言及はどこにも見つかりません.Rd2pdfの唯一のオプションは次のとおりです。

既存のパッケージを引き継いでいます。Rが関数を明示的にエクスポートする必要がある前に、パッケージは.Rdドキュメントで作成されました。

私の最初のステップは、Rd2roxygenを使用してドキュメントをroxygenに変換することでした（このパッケージを提供してくれたYihuiとHadleyに感謝します！）。

ただし、関数がエクスポートされないため、パッケージは機能しません。デフォルトですべての関数をエクスポートしたいだけです。この時点で、私の一般的なアプローチは、各関数で見つかる正規表現を識別し（##' @return適切なターゲットになる）、 ##' @exportその上の行に挿入することであるように思われます。

擬似コードの場合：

結果は次のようになります。

と

関数のリストを取得してNAMESPACEに追加すると、各関数の上のroxygenコードにないdevtools::document("mypackage")場合は上書きされるため、機能しません。@export

質問：パッケージ内の各関数のroxygenドキュメントに@exportを追加する最も効率的な方法は何でしょうか？

さらに良い代替策は、それに応じて、NAMESPACEおよび解析exportとmethodステートメントを解析することです。

誰かがでテンプレートタグを適切に使用する方法の例を提供できますかRoxygen2。私は（私にとって）最も明白なことをしようとしました：

私のpackageName-package.Rファイル：

次に、ファイルでsomeFunction.R

エラーが発生します：

私は、一般的に繰り返される定義の例などを文書化するための1つの場所を作ろうとしています。これらのものが一連の関数内にネストされている場合、私は使用してい@inheritParmsます。しかし、定義やその他の説明など、いくつかの場所で使用されています。@templateとの使用法を高低で検索しましたが、@templateVar何も見つかりませんでした。

ありがとう。

私が書いたパッケージを学生に使ってもらうクラスを教えたことがあります。クラスが終了したので、関数のドキュメントに沿って、これらの各関数のコードをインラインで提供したいと思います。これを達成するために設定できるグローバルフラグはありますか? ある種のコードハック？

この質問に関して自分自身の解決策を見つけようとしていることに関連して、私は有効な Rd マークアップを書き込もうとしていることに気づきました。私が望むのは、という名前のセクションを追加し、Raw Function Codeその下に関数のコードを配置することです。Rdファイルを変更して含めるスクリプトを作成することにより、この点で限定的な成功を収めました

ただし、(スペースまたはタブのいずれかを使用して) .Rd ファイルにテキストを手動で適切に配置したとしても、各行の最初の空白が取り除かれ、望ましくない外観の機能が残っているようです。空白の前に開始文字を指定すると、空白が保持されることに気付きました。ただし、生成された PDF から直接コピー アンド ペーストできるようにしたいので、開始文字を提供しませんでした。

parseRdを確認したところ、テキストには LaTeX ライク、R ライク、逐語の 3 種類があることがわかりました。関数コードを \code と \verb に入れようとしましたが、どちらも望ましい結果が得られなかったようです。最初の空白を保持するにはどうすればよいですか?

私は自分で使用する小さなパッケージを作成しましたが、devtools を使用するとすべてがうまくいきました。ただし、R CMD Check を実行しようとしたところ、いくつかのエラーが発生しました。これは、私の使用法と例がパッケージに含まれていないベース R の関数を使用しているためと思われます。たとえば、ここに私の最小限の関数と roxygen ドキュメントがあります。

そしてR CMDチェックは

これらの関数が base に記述されていることを R CMD Check/roxygen2 に伝える方法はありますか?

できればroxygen->rd変換を行う前に、roxygenが見るコメントを変換できるメカニズムはありますか？

たとえば、次のようなものがあるとします。

ここで、roxygenがコメントを解析する前に、コメントの変換を実行したいとします。たとえば、バックティック内のすべてのインスタンスを。に置き換えます\code{}。すなわち：

どういうわけかroxygenにフィードpreprocessして、roxygenがドキュメントを生成する前（またはこの場合は動作した後）にドックレットで実行できるようにすることはできますか？

.rファイル内で永続的な検索置換を実行したくありません。私の例から推測できるように、私はroxygenコメントでいくつかの基本的なマークダウンのサポートを目指しているので、.r読みやすさを維持するために（そしてプログラムで内容を挿入するために）ファイルをそのままにしておきたいと思います\code{..}。

ファイル内で検出されたすべてのroxygenスタイルのコメントroxygeniseに対して実行される独自のバージョンを記述し、それらを一時的にどこかに保存してから、それらに対して実際に実行する必要がありますか？preprocess roxygenise

R パッケージのビルドに使用devtoolsしていますが、エンド ユーザーに表示されるように設計されていない関数がいくつかあります。ただし、これらの関数は で C コードを呼び出す必要があるため、.Rd ファイルを自動生成する関数の上.Callに記述しなければなりません。@useDynLibそのようにして、パッケージをビルドするときに、@exportこれらの関数を含めなくても、ヘルプ ドキュメントに表示されます...ドキュメント化されていても、これらの関数を抑制する方法はありますか? ありがとう！

短いバージョン:を使用Normalしてパッケージ内のドキュメントをエミュレートできますか?statsroxygen

ロングバージョン：私はパッケージに取り組んでおり、グループへの一般的な参照となる1つの見出しの下に収集された共通の入力/パラメーターを持つ多くの関数を持つことにより、ドキュメントを読みやすくしようとしていました. 各機能は、エンド ユーザーが個別に利用できる必要があります。

Normal私はインスピレーションとして、正規分布に関連する多くの方法を提供するドキュメントを参考にしましたstats::dnorm()。

検索すると、エクスポートされた関数またはオブジェクトではないように見えます?dnormが、ヘルプ セクションの名前がわかりました。NormalNormal

私が試したのは、次のものをに入れることfuns.Rです：

次に、上記で実行roxygen2します。問題は、R CMD checkこの最小パッケージで実行すると、パッケージを としてロードできないことが判明することundefined exports: funsです。行を削除すると##' @name funs、パッケージは通過しますがR CMD check、ヘルプ セクションの名前sum1はfuns. 例のセクションの下に次を追加すると:

それは成功し、希望どおりにフォーマットされたヘルプが表示されますが、名前を正しく表示するために意味のない関数をエクスポートしています。

のソースヘルプファイルを調べてみましたstatsが、.Rdx表示方法がわからない形式になっています。

また、関連して、 とはどのようなものです Normalか？

アップデート：

@TylerRinker - これは私が最初に試したものではないかと思います。これにより、関数が1つの.Rdファイルに結合されますが、関連するヘルプの名前は最初の関数の名前と同じです。これは私が避けようとしていたものです:

@Andrie - この解決策はまったく同じ問題を引き起こします。ヘルプの名前は最初の関数と同じです。

もしかしたらこれしか出来ない…

R関数を文書化するコンテキストで、方程式に行列をタイプセットしたいと思います。実際のところ、amsmath既定では R ドキュメントでは使用できず、対応する数学環境が既に開かれてeqnarrayいるため機能しません。\deqn

では、プロはどのようにそれを行うのですか？またはそのようなものを介しtabularて？