web-dev-qa-db-ja.com

Rパッケージの開発にデータ例を含める

次のような関数の上に書かれたコメントとしてデータ例を組み込む方法を学びたいと思っています。

##' @examples 
##' ## Set working directory...
##' ## Load data into R session:
##' data <- system.file("extdata", "data.txt", package="...", sep="\t", header=TRUE, stringsAsFactors = FALSE)
##'
##' ## For reproducible results:
##' set.seed(999)

「data.txt」ファイルをディレクトリ/ pkg_Name/inst/extdata /に置きます。ただし、R CMDチェックは、このステップでエラーを示します。 RCMDビルドとRCMDインストールに進むと、パッケージをロードした後、データをRセッションに取り込むことができません...誰かが何が悪かったのか教えてもらえますか？これは、関数ヘルプドキュメントの最後にデータ例を含める正しい方法ですか？

どうもありがとう！

rpackageroxygen2
24
alittleboy

データを含むCRANパッケージを見て、そのアプローチをコピーしてください。数週間前に職場専用パッケージにデータを追加したところ、正常に機能しました...

その価値については、マニュアルにそれを説明するセクション 1.1.5パッケージ内のデータ があります。

11
Dirk Eddelbuettel

Hadley Wickhamは、彼の著書に章があります "Rパッケージ" on データをRパッケージに組み込む方法 。

Dirkは、 パッケージ内のデータ に関する公式ドキュメントを指しています。

または、rdaファイルとroxygenを使用してデータを組み込む方法の1つについて、ggplot2パッケージから学習する例を次に示します。

これはggplot2パッケージのdataディレクトリです 。この例では、各データファイルは個別のrdaファイルに保存されます（たとえば、save(foo, file='foo.rda')を使用して生成されます。

enter image description here

データのRmdヘルプファイルを生成するためのRoxygenコマンドについては、 ファイルdata.r を参照してください。例：

#' 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:
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \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 color: 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)
#' }
"diamonds"
32
Jeromy Anglim
x <- sample(1000)
devtools::use_data(x, mtcars)

http://r-pkgs.had.co.nz/data.html

1
HelloWorld