問題タブ [roxygen2]

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

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

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

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

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

と

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

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

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

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

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

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

devtools関数install_github()function が簡単にインストールできるように、パッケージを作成して github にプッシュしました。つまり、github リポジトリのファイル構造は、DESCRIPTIONとNAMESPACEが上部にあり、各関数のファイルとファイルをそれぞれ含む/Rと/manフォルダがあります。*.R*.Rd

新しい機能を追加して、いくつかのアップグレードを行いたいと思います。

#'それぞれの新しいファイルの関数の上に、関連するすべての roxygen type ( ) テキストがありますが、ファイルの読み取りと関連ファイルの書き込みに役立つ.R、または関連するパッケージ関数が見つかりません。うまくいけば、これはそれほど難しくありません...私が求めているのは、1つのファイルだけをroxygeniseして別の既存のパッケージに追加することは可能ですか? DESCRIPTION、NAMESPACE ファイルも更新するようにします。これらすべての変更をgithubのリモートリポジトリに追加、コミット、およびプッシュできるようにするには?roxygen2.R.Rd

私はすでに何度も次の問題に遭遇しました。

2つのクラスがclassAありclassB、次のファイルで説明されているとしますclassA.R。

とclassB.R

これらのファイルは、によってアルファベット順に読み取られたと思いますがroxygen2、そうではありません。パッケージをビルドしようとすると、次のエラーが発生する可能性があります。

roxygenize()ファイルを読み取る順序、つまりどのクラス定義を他のクラス定義よりも先に読み取る必要があるかを確認するにはどうすればよいですか？

注：私は自分の質問に答えたことを知っています。これは、私がこの問題に頻繁に遭遇し、のコードを見て、これを行うための適切な方法を実現したためですroxygen2。参考までに、これが私の調査結果です。

私は同じ家族で 2 つの機能を持っています。私は roxygen2 を使用して文書化しており、それらを同じヘルプ ファイルにまとめることができますが、文書内の使用法フィールドに両方の機能を持たせる方法がわかりません。

私は試した：

これは与える：

カンマで区切って試してみたところ、最初のものだけが得られ、別の使用タグを試してみたところ、最初のものだけが使用されます。

roxygen を使用して使用法フィールドに 2 つの項目を作成するにはどうすればよい?lapplyですか?

編集：GeeSeeの質問ごとに、.Rファイル全体

重複の可能性：
Roxygen2を使用してS4クラススロットを適切に文書化する方法

S4 classesRStudioとを使用したパッケージを作成したいと思いますroxygen2。パッケージにroxygen2いくつかを導入したとき、構文を使用してすべての関数をすでに文書化していました。S4 classes

今、私は、すぐに使える「@slot」機能がないことに気づきました。それで、他の機能のためにすべてのドキュメントを機能させ続け、このスレッドS4 classesで提案されているように手動でドキュメントを作成するにはどうすればよいでしょうか？

つまり、古い学校の機能との両方を含むパッケージを構築するために、どのワークフローをお勧めしますS4 classesか？

編集：.Rdファイルを作成しないようにRStudioで構築されたツールを構成することをお勧めしますか。roxygenize手動で情報を追加し、後で情報を追加しますか？それでも、これはクラスの手動で生成された.Rdファイルを上書きすることにつながります...

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

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

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

私はジェネリック関数（ LINK、確かに私が把握するのは少し難しい）とこの質問（LINK ）に基づいて正しく設定したと思うジェネリック印刷関数を持っています。ただし、チェックで警告が表示されます。以下は、モック関数、print メソッド、roxygen のドキュメント、およびチェックからのエラーです。print 関数が何をしているかの背景について。基本的に、出力がクラスのように見えないようにしたいのですが、後続の関数によってそのオブジェクトを処理するためのクラスが含まれています。警告を消す (そして印刷機能を維持する) にはどうすればよいですか?

警告：

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

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

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

\deqn{}{}パッケージ内の関数の方程式を文書化するために roxygen2 を使用しています。deqnLaTeX 式では空白が無視されるため、LaTeX ( の第 1 引数) は正常にレンダリングされますが、ASCII ( の第 2 引数deqn) 表現​​に問題があります。

問題は、私のフォーマットが壊れていることです（roxygenはdeqnコマンド全体を「1行」に入れ、その行を約60列で折り返すようです）。.R ファイルの roxygen コマンド/コメントの空白の書式設定を roxygen2 に保持させる方法はありますか?

ファイルに次のコードがありますexample.R。

そして、次の R コードを使用してexample.Rdファイルを生成します。

コマンド ラインで次のコマンドを使用して、example.Rd ファイルのテキスト表現を生成できます。

上記のコマンドの出力の詳細セクションは次のようになります。

一方、次のようにしたい：

パッケージでS3メソッドを使用しようとしていますが、ここで質問した後、セットアップ方法を理解したと思いました。Roxygenを使用してRパッケージをビルドするときのS3メソッドの整合性の警告

しかし、今では予期しない結果が得られます。以下のコードをRで直接実行すると、期待どおりの結果が得られますが、パッケージにコンパイルすると、正しい結果が得られません（から一意の単語のみを取得する必要がある場合に、単語が2回カウントされることに注意してくださいvector a）。何を間違って設定しているかわかりません。

.Rファイル：

コマンドラインからコードを実行する（予想される動作）：

パッケージコンパイル後の出力：