roxygen2 «Ошибка: titlerequires a value»

Question

Я получаю ошибку от 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

Edit

В @ 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 

, который до сих пор порождающий ту же ошибку.

Answer 1

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

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

---

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

Код по @Andrie, #' @aliases kmmisc package-kmmisc, имеет @aliases problem. В 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 

Answer 2

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

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

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

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

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

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

---

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