R Language
ロキシーゲン2

パラメーター

roxygen2でパッケージを文書化する

roxygen2で書く

roxygen2は、Hadley Wickhamによって作成されたパッケージです。

これは、 #'始まる行にRスクリプト内のドキュメントを含めることを可能にします。ドキュメントに渡されるさまざまなパラメータは@で始まります。例えば、パッケージの作成者は次のように書かれます：

#' @author The Author

たとえば、次の関数を文書化したいとします。

mean<-function(x) sum(x)/length(x)

この関数に小さな記述を書いて、次のようにパラメータを説明したいと思います（各行については後で説明します）。

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• 最初の行#' Meanはドキュメントのタイトルです。次の行がコーパスを作成します。
• 関数の各パラメータは、関連する@paramを通じて詳述されなければならない。 @exportは、この関数名をエクスポートする必要があることを示しているため、パッケージがロードされたときに呼び出すことができます。
• @keywordはヘルプを探す際に関連するキーワードを提供します
• @importFromは、この関数またはあなたのパッケージで使用されるパッケージからインポートするすべての関数をリストします。パッケージの完全な名前空間をインポートするには@importを@importことができます
• 例は@exampleタグの下に記述されています。
  • 最初のパッケージは、パッケージのビルド時に評価されます。
  • 2番目のコマンドは\dontrunコマンドのために - 長い計算を防ぐ - 通常はありません。

ドキュメントの作成

ドキュメントは、 devtools::document()を使用して作成できます。また、 devtools::check()は自動的にドキュメントを作成し、関数のドキュメントで不足している引数を警告として報告することに注意してください。