roxygen2 "Ошибка: название требует значения" - PullRequest
Новая
       7

roxygen2 "Ошибка: название требует значения"

6 голосов
/ 06 октября 2011

Я получаю ошибку от roxygenize(), которую не могу понять.У меня есть пакет моих разных функций, в которых файлы .Rd генерируются с помощью roxygen.

Ошибка: Error: titlerequires a value, что говорит об отсутствии тега @title.Однако в файле kmmisc-package.R есть тег @title, поэтому я не уверен, в чем проблема.

kmmisc-package.R содержит: 

##' Miscellaneous Functions
##' 
##' \tabular{ll}{
##' Package: \tab kmmisc\cr
##' Type: \tab Package\cr
##' Version: \tab 0.1-2\cr
##' Date: \tab 2011-10-06\cr    
##' License: \tab GPL-2\cr
##' LazyLoad: \tab yes\cr
##' LazyData: \tab yes\cr
##' }
##' 
##' @author Me \email{my@@email}
##' 
##' Maintainer: Me \email{my@@email}
##'
##' @name kmmisc-package
##' @docType package
##' @title KM Misc
##' @keywords package
##' 
NULL

Я используюR 2.13.2 с roxygen2 2.1 только что переустановили из CRAN.Полный sessionInfo() находится в сущности в https://gist.github.com/1268056

Редактировать

По предложению @ Andrie у меня теперь есть 

#' Miscellaneous Functions
#' 
#' \tabular{ll}{
#' Package: \tab kmmisc\cr
#' Type: \tab Package\cr
#' Version: \tab 0.1-2\cr
#' Date: \tab 2011-09-14\cr    
#' License: \tab GPL-2\cr
#' LazyLoad: \tab yes\cr
#' LazyData: \tab yes\cr
#' }
#' 
#' @author Me \email{my@@email}
#' 
#' Maintainer: Me \email{my@@email}
#' @name package-kmmisc
#' @docType package
#' @title KM Misc
#' @keywords package
#' @aliases kmmisc package-kmmisc
#'
#' 
NULL

, который все еще генерирует ту же ошибку.

Ответы [ 2 ]

2 голосов
/ 07 октября 2011

Я не смог воспроизвести ошибку из вашего первого кода ... Получаете ли вы такое же сообщение об ошибке от roxygenize() к следующему простому примеру? 

#' A test function
#'
#' Description
#'
#' Details
#'
#' @param x numeric number
f1 <- function(x) {
  x
}

Дополнительныйинформация :

Код @Andrie, #' @aliases kmmisc package-kmmisc, имеет проблему @ aliases .В roxygen2 2.1, #' @aliases a-b, который имеет дефис, генерирует цитируемый тег Rd \alias{"a-b"}.В этом случае код не имеет проблем, но в другом случае требует некоторого внимания.Конечно, если вам нужны теги в кавычках, вы добавляете #' @aliases a-b.

Так что я думаю, что лучше заменить #' @aliases kmmisc package-kmmisc на #' @aliases kmmisc в этом случае: 

#' Miscellaneous Functions
#'
#' \tabular{ll}{
#' Package: \tab kmmisc\cr
#' Type: \tab Package\cr
#' Version: \tab 0.1-2\cr
#' Date: \tab 2011-09-14\cr
#' License: \tab GPL-2\cr
#' LazyLoad: \tab yes\cr
#' LazyData: \tab yes\cr
#' }
#'
#' @author Me \email{my@@email}
#'
#' Maintainer: Me \email{my@@email}
#' @name package-kmmisc
#' @aliases kmmisc
#' @docType package
#' @title KM Misc
#' @keywords package
NULL
1 голос
/ 06 октября 2011

Попробуйте следующее:

  • Раскомментируйте свои заявления о содержании кислорода.(Это может быть SO артефакт, но каждая линия кислорода должна начинаться с # ', то есть с одной #)

  • Внести следующие изменения в документацию 

    #' @name package-kmmisc
    #' @aliases kmmisc package-kmmisc

Другими словами:

  • Измените значение @name
  • Добавьте псевдоним kmmisc

Это единственные различия между вашим примером и документацией к моему пакету.

...