документирование набора данных с помощью 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
    

Когда я 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 будет хорошим первым предположением. Любые подсказки были бы потрясающими.

Если Хэдли наблюдает, я замечаю, что раздел \usage не создается, а директива @usage игнорируется.

я использую roxygen-2.2.2 на R 2.13.1


person drmjc    schedule 05.03.2012    source источник
comment
Я не уверен, что директива @export используется для наборов данных. Попробуйте удалить это.   -  person Brandon Bertelsen    schedule 05.03.2012
comment
вы не должны экспортировать объект данных   -  person Yihui Xie    schedule 05.03.2012
comment
Спасибо, парни. для этого потребовалось 2 исправления (1) согласно написанию расширений R 1.5.1, сохранить объекты как .rda (не .RDa); и (2) удалить @export   -  person drmjc    schedule 06.03.2012
comment
@mjc Пожалуйста, опубликуйте свой комментарий как ответ и отметьте его как ответ, чтобы закрыть этот вопрос.   -  person Ari B. Friedman    schedule 03.08.2012
comment
@mjc, пожалуйста, опубликуйте ответ и примите его, чтобы этот вопрос не остался без ответа.   -  person GSee    schedule 15.10.2012


Ответы (1)


Это потребовало 2 исправлений:

  1. Как описано в Написание расширений R 1.1.5, Данные в пакетах, сохраните объекты как .rda вместо .RDa
  2. удалить @export из Roxygen
person Andrie    schedule 18.10.2012