документирование набора данных с помощью roxygen2

Я пытаюсь задокументировать некоторые наборы данных в пакете R, используя roxygen2. Рассмотрим только один из них:

  • У меня есть mypkg/data/CpG.human.GRCh37.RDa
  • , который содержит объект с именем CpG.human.GRCh37
  • и файл с именем: mypkg/R/cpg-data.R, который содержит:

    #' @name CpG.human.GRCh37
    #' @title Острова CpG - человек - сборка генома: GRCh37/hg19
    #' @description В этом наборе данных перечислены геномные местоположения CpG-островков человека,
    #' с координатами, основанными на построении генома GRCh37/hg19.
    #' Данные @docType
    #' @использование CpG.human.GRCh37
    #' @format экземпляр \code{RangedData}, 1 строка на остров CpG.
    #' @source Браузер таблиц UCSC
    #' @автор Марк Коули, 2012-03-05
    #' @экспорт
    НУЛЕВОЙ
    

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

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

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

19
задан Viliam Simko 21 October 2015 в 23:56
поделиться