2012-03-05 17 views
19

Sto provando a documentare alcuni set di dati in un pacchetto R usando roxygen2. Considerando solo uno di questi:dataset di documentazione con roxygen2

  • ho mypkg/data/CpG.human.GRCh37.RDa
  • che contiene un oggetto chiamato CpG.human.GRCh37
  • e un file chiamato: mypkg/R/cpg-data.R, che contiene:

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

Quando ho roxygenize, questo viene creato mypkg/man/CpG.human.GRCh37.Rd, contenente:

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

e export(CpG.human.GRCh37) viene aggiunto il file NAMESPACE.

ma quando ho R CMD CHECK ottengo:

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

hanno nessun posto ho detto R dove trovare questo set di dati, anche se presumo che il mypkg/data/<name>.RDa sarebbe una buona prima ipotesi. Qualsiasi suggerimento sarebbe fantastico.

Se Hadley sta guardando, noto che una sezione \ usage non viene creata e la direttiva @usage viene ignorata.

sto usando roxygen-2.2.2, sulla R 2.13.1

+4

non sono sicuro che la direttiva '@ export' viene utilizzato per i dati di SE ts. Prova a rimuovere questo. –

+6

non si dovrebbe esportare l'oggetto dati –

+3

grazie ragazzi. ciò richiedeva 2 correzioni (1) come da Estensioni Writing R 1.5.1, salvare gli oggetti come .rda (non .RDa); e (2) rimuovere @export – drmjc

risposta