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 コードを 1 つのファイルに含めることができます。 .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

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