dokumentowanie zestawu danych z roxygen2

Question

Próbuję udokumentować niektóre zestawy danych w pakiecie R za pomocą roxygen2. Biorąc pod uwagę tylko jeden z nich:

• mam mypkg/data/CpG.human.GRCh37.RDa
• który zawiera obiekt o nazwie CpG.human.GRCh37

• i plik o nazwie: mypkg/R/cpg-data.R, który zawiera:

  #' @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 
  

Kiedy roxygenize, to zostaje utworzone mypkg/man/CpG.human.GRCh37.Rd, zawierające:

\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} 

i export(CpG.human.GRCh37) zostaje dodany plik NAMESPACE.

ale kiedy R CMD CHECK uzyskać:

... 
** testing if installed package can be loaded 
Error in namespaceExport(ns, exports) : 
    undefined exports: CpG.human.GRCh37 
Error: loading failed 
... 

Nigdzie nie mówiłem R, gdzie znaleźć ten zbiór danych, chociaż chciałbym założyć, że mypkg/data/<name>.RDa byłby dobry pierwszy przypuszczenie. Wszelkie wskazówki będą niesamowite.

Jeśli obserwacja Hadleya, zauważam, że sekcja \ użytkowanie nie została utworzona, a dyrektywa @usage jest ignorowana.

używam roxygen-2.2.2, na R 2.13.1

Answer 1

Wymagało 2 poprawki:

1. Jak wyjaśniono w Writing R extensions 1.1.5, Data in packages, z wyjątkiem obiektów jak .rda zamiast z .RDa
2. remove @export z Roxygen