roxygen2 を使用して、R パッケージ内のいくつかのデータセットを文書化しようとしています。これらのうちの1つだけを考慮してください:
- 私は持っている
mypkg/data/CpG.human.GRCh37.RDa
- と呼ばれるオブジェクトを含む
CpG.human.GRCh37
と呼ばれるファイル:
mypkg/R/cpg-data.R
には、以下が含まれます。#' @name CpG.human.GRCh37 #' @title CpG islands - human - genome build: GRCh37/hg19 #' @description This data set list the genomic locations of human CpG islands, #' with coordinates based on the GRCh37 / hg19 genome build. #' @docType data #' @usage CpG.human.GRCh37 #' @format a \code{RangedData} instance, 1 row per CpG island. #' @source UCSC Table Browser #' @author Mark Cowley, 2012-03-05 #' @export NULL
私がroxygenizeすると、これが作成されmypkg/man/CpG.human.GRCh37.Rd
、以下が含まれます:
\docType{data}
\name{CpG.human.GRCh37}
\alias{CpG.human.GRCh37}
\title{CpG islands - human - genome build: GRCh37/hg19}
\format{a \code{RangedData} instance, 1 row per CpG island.}
\source{
UCSC Table Browser
}
\description{
This data set list the genomic locations of human CpG
islands, with coordinates based on the GRCh37 / hg19
genome build.
}
\author{
Mark Cowley, 2012-03-05
}
\usage{CpG.human.GRCh37}
\keyword{datasets}
export(CpG.human.GRCh37)
ファイルが追加されますNAMESPACE
。
しかし、私R CMD CHECK
が得たとき:
...
** testing if installed package can be loaded
Error in namespaceExport(ns, exports) :
undefined exports: CpG.human.GRCh37
Error: loading failed
...
このデータセットの場所を R に伝えたことはありませmypkg/data/<name>.RDa
んが、最初の推測としては適切だと思います。どんなヒントも素晴らしいでしょう。
Hadley が見ていると、\usage セクションが作成されておらず、@usage ディレクティブが無視されていることに気付きます。
R 2.13.1でroxygen-2.2.2を使用しています