問題タブ [rd]

この SO question on documenting a data set with Roxygenなどの質問を読んだ後、データセット (これを と呼びます) を文書化することができましcellsた。この後、を実行すると が表示されます。data(package="mypackage")data(cells)cellsls()

ただし、多くのパッケージでは、データはdata()呼び出しを必要とせずにすぐに利用できます。また、実行時にデータ名が表示されませんls()。例として、baseballに付属のデータ セットがありplyrます。のソースを見ましたが、plyrこれがどのように行われるかわかりません。

私のhyperSpecパッケージは、スペクトスコピックデータセットを操作するための関数を提供します。他のパッケージからのかなりの数の関数にhyperSpecメソッドを提供します。ただし、これらの他のパッケージのいくつかはSuggests:、特定の機能を使用しない可能性がある場合に、ユーザーに他の20個のパッケージ（依存関係をカウント）のようなものをインストールするように強制したくないため、リストしました。

コーディングの観点からは、それはうまく機能します。ただし、.Rdファイルでそれを処理する方法がわかりません。しかし、これはかなり一般的な問題であると確信しています。

\code{\link[otherpkg]{fun}}otherpkgが利用可能であるという保証がないため、通常は確実に機能しません。otherpkgがインストールされていない場合、リンクは壊れています。R CMD checkこれは、Winbuilderやr-forgeなどで検出されます。つまり、パッケージはCRANチェックに合格しません。

どのパッケージを見るのが良い例ですか？

私がこれまでに見つけた唯一のヒント（解決策はありませんが）：https ：//stat.ethz.ch/pipermail/r-devel/2009-November/055425.html （しかし、その電子メールへの回答はありませんでした）。

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

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

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

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

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

と

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

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

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

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

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

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

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

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

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

パッケージを調べて、各関数のヘルプ ファイルに記載されている作成者を特定したいと考えています。

R のヘルプ ファイルから要素を抽出する関数を探したところ、見つかりました。私が見つけることができる最も近いものは、Noam Ross からのこの投稿です。

そのような機能は存在しますか？(そうでない場合は、Rd ファイルを解析し、関心のある特定の要素を見つけるために、Noam のコードをハックすると思います)。

ありがとう、タル。

考えられるコード例:

'lm' は、線形モデルを近似するために使用されます。回帰、分散の単一層分析、および共分散の分析を実行するために使用できます (ただし、'aov' はこれらのより便利なインターフェイスを提供する場合があります)。

指定したファイルがルートに存在しないすべてのフォルダーとサブフォルダーを削除する必要がありますが、指定したファイルが見つかった場合はすべてのファイルとフォルダーを残します。ファイルはルートになります。つまり、c:\list\12345\1\1 12345 には「完全な」txt ファイルが含まれているため、このフォルダーとファイル構造はそのままにしておきます。つまり、c:\list\67891\1\1 67891 には「完全な」txt ファイルが含まれていないため、67891 とそのすべてのサブフォルダーとファイルを削除します。

私は何も試していません。私はcmdシェルにまったく慣れていません。または、これを行うユーティリティがあるかもしれません。

私はUNIX環境で作業しており、ユーティリティ機能がヘルプページRdにリンクする必要があるパッケージを作成していgrDevices::win.metafileます(これはWindows固有です)。私の.Rファイル（を使用roxygen2）は

ただし、 に移動するR CMD checkと、警告が発行されます。

Cross-references of Writing R Extensionsを見てきましたが、唯一の代替方法[grDevices:win.metafile]{win.metafile}は、同じ結果が得られるようです (正直言って、その意味を完全には理解していませんでした)。

チェックを「黙らせる」ためのヒントはありますか？ありがとう、ルカ