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

Question

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

データ ディレクトリにいくつかの .R ファイルを配置しました。データが data() で取得されると、生データ ファイルが読み込まれ、いくつかの変換が実行されます。

Answer 1

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

Answer 2

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"

Answer 3

ggplot2 パッケージの例を調べると役に立ちました。

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

いくつかの注意事項:

• データセットのすべての Roxygen コードは、パッケージ.rのディレクトリ内の 1 つのファイルに含めることができます。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

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