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

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

19 голосов
/ 05 марта 2012

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

но когда я 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

1 Ответ

15 голосов
/ 18 октября 2012

Требуется 2 исправления:

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