問題タブ [roxygen]

私はroxygenを初めて使用し、それを使用して新しい/カスタムパッケージをすばやく作成する方法を見つけるのに苦労しています.

つまり、コマンドを実行できるように、usingpackage1というパッケージを作成することが最小要件であることを知りたいです。devtoolsroxygen2/3

それぞれ 2000 と 4000 のランダム法線を生成する

それでは、最も単純な例を見てみましょう。

私が2つの機能を持っていてfun1、fun2

と

パラメータは数値で、戻り値は数値です。これは S3 メソッドではないことは確かです。タイトルを fun1 と fun2 と呼びましょう....他にどのような情報を提供する必要があるかわかりません。fun1 と fun2 を別々の.Rファイルに入れ、abit を追加することはできます#'が、roxygen に関連するすべての要件を含めることはできません。名前空間の名前は fun1 と fun2 だけだと思いますか? パッケージの説明は、私に関連する一般的な情報にすぎません...そしてパッケージの機能ですか？

ステップバイステップのガイドは喜んで受け取ります。

編集：以下は、私がどこまで始めたかです...

次のようにしてパッケージを作成できます...しかし、roxygenを使用してドキュメントを作成することはできません...

そして、ここで、一連のステップが欠落しているかどうかわかりません...

インストールしようとすると、次のエラーメッセージが表示されます

重複の可能性:
Roxygen: ジェネリックの S3 メソッドを別のパッケージに適切に文書化する方法は?

パッケージ coda で定義されている as.mcmc に基づいてメソッド as.mcmc.mcmcComposite を作成しようとしています。コードは次のとおりです。

うまく機能しますが、チェック中にエラーが発生します。

このようなエラーを修正する方法がわかりません。アドバイスをありがとう

マルク・ジロンド

重複の可能性:
S3 メソッドの R-oxygen ドキュメントがチェック中にエラーを生成する

S3メソッドの私の質問R-oxygenドキュメントは、チェックが他の「正確な複製」であるとして閉じられている間にエラーを生成します...いいですね。しかし、もちろん、投稿する前にこれらの質問をチェックしましたが、答えが見つかりません! ここにいる人は、トピックを閉じる前に必ず !

タグ @method を使用しないと、チェック中に警告が表示されます (以前の投稿)。

@method を使用すると、チェック中にエラーが発生します (以下を参照)。

マルク・ジロンド

パッケージ coda で定義されている as.mcmc に基づいてメソッド as.mcmc.mcmcComposite を作成しようとしています。コードは次のとおりです。

重複の可能性：
Roxygen2スタイルのドキュメントで「@」をエスケープする

次のように、roxygenドキュメントで@を使用するにはどうすればよいですか？

これは、実行時に警告をスローしroxygenize、@を.Rdファイルに入れません。

単純で具体的な例として：

ただし、パッケージをビルドしようとすると、関数が無視され、ドキュメントが生成されないようです。

http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functionsにバイナリインフィックス関数に関する1行の宣伝文句があるようですが、私は苦労していますそれを解析する時間、そしてそれがRoxygenのドキュメントに何を意味するか。

Rパッケージのソース コード用にフォルダ内のディレクトリ構造を使用したいと考えています。たとえば、Rフォルダー内に、algosエクスポートして文書化したい機能を含むフォルダーがあります。ただしroxygen2、デフォルトでは、フォルダーのサブフォルダーを通過しないようですR。

@include`R/algos/algo1.r' のファイルに次のようなキーワードを使用しようとしました

しかし、成功しませんでした。Rソースコードにサブフォルダーを使用する簡単な方法はありますか?

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

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

次に、ファイルでsomeFunction.R

エラーが発生します：

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

ありがとう。

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

短いバージョン:を使用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て？