Я пытаюсь документировать некоторые наборы данных в R-пакете с помощью roxygen2. Рассматривая только один из них:
- У меня есть
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
будет хорошим предположением.
Любые подсказки были бы удивительными.
Если Хэдли наблюдает, я заметил, что раздел \use не создан и директива @usage игнорируется.
Я использую roxygen-2.2.2, на R 2.13.1