web-dev-qa-db-ja.com

roxygenを使用してデータセットを文書化するにはどうすればよいですか？

Roxygenプロセスでパッケージのデータディレクトリに.Rファイルを含めることは可能ですか？

データディレクトリにいくつかの.Rファイルを配置しました。 data（）をソースとする場合、生データファイルを読み込み、いくつかの変換を実行します。

rdocumentation-generationr-packageroxygen
52
Karsten W.

Roxygenは、Rファイル内のどこでも使用できます（つまり、関数の後に関数を続ける必要はありません）。また、RドキュメントのdocTypeをドキュメント化するためにも使用できます。

したがって、データを別のブロック（次のようなもの）に文書化することができます。

#' This is data to be included in my package
#'
#' @name data-name
#' @docType data
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
#' @keywords data
NULL
44
Shane

Roxygen2> 4.0.0以降、文字列として定義されたオブジェクトの名前を文書化することにより、他の場所で定義されたデータオブジェクトを文書化できます。

#' This is data to be included in my package
#'
#' @author My Name \email{blahblah@@roxygen.org}
#' @references \url{data_blah.com}
"data-name"
33
hadley

Ggplot2パッケージの例を調べると便利だと思いました。

githubのggplot2.r を参照してください

注意事項：

  • データセットのすべてのRoxygenコードは、パッケージのRディレクトリにある単一の.rファイルに含めることができます。

例については、diamondsデータセットを参照してください。

#' Prices of 50,000 round cut diamonds
#'
#' A dataset containing the prices and other attributes of almost 54,000
#'  diamonds. The variables are as follows:
#'
#' \itemize{
#'   \item price. price in US dollars (\$326--\$18,823)
#'   \item carat. weight of the diamond (0.2--5.01)
#'   \item cut. quality of the cut (Fair, Good, Very Good, Premium, Ideal)
#'   \item colour. diamond colour, from J (worst) to D (best)
#'   \item clarity. a measurement of how clear the diamond is (I1 (worst), SI1, SI2, VS1, VS2, VVS1, VVS2, IF (best))
#'   \item x. length in mm (0--10.74)
#'   \item y. width in mm (0--58.9)
#'   \item z. depth in mm (0--31.8)
#'   \item depth. total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)
#'   \item table. width of top of diamond relative to widest point (43--95)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name diamonds
#' @usage data(diamonds)
#' @format A data frame with 53940 rows and 10 variables
NULL

これにより、次のようなヘルプファイルが作成されます。

roxygen documentation example

22
Jeromy Anglim