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