roxygen2 "Błąd: titlerequires a value"

Question

Otrzymuję błąd z roxygenize(), którego nie mogę zrozumieć. Mam pakiet moich różnych funkcji, w których pliki .Rd są generowane przez roxygen.

Błąd to Error: titlerequires a value, co sugeruje, że nie ma znacznika @title. W pliku kmmisc-package.R znajduje się jednak znacznik @title, więc nie jestem pewien, na czym polega problem.

kmmisc-package.R zawiera:

##' 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 

Używam R 2.13.2 z roxygen2 2.1 tylko zainstalowane z CRAN. Kompletny sessionInfo() jest w GIST w https://gist.github.com/1268056

Edytuj

AT @ Andrie sugestią, teraz mam

#' 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 

który nadal wytwarzające ten sam błąd.

Answer 1

Nie mogę odtworzyć błędu z pierwszego kodu ... Czy otrzymujesz ten sam komunikat o błędzie z roxygenize() dla następującego prostego przykładu?

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

---

Dodatkowa informacja:

Kod przez @Andrie, #' @aliases kmmisc package-kmmisc, ma @aliases problem. W roxygen2 2.1, #' @aliases a-b, z łącznikiem, generowany jest znacznik Rd \alias{"a-b"}. W tym przypadku kod nie stanowi problemu, ale w innym przypadku wymaga uwagi. Oczywiście, jeśli potrzebujesz cudzysłowów, dodaj #' @aliases a-b.

Więc myślę, że lepiej zastąpić #' @aliases kmmisc package-kmmisc z #' @aliases kmmisc w tym przypadku:

#' 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

Spróbuj wykonać następujące czynności:

• Odkomentuj wasze wypowiedzi roxygen. (Może to być SO artefakt, ale każda linia roxygen powinien zacząć # ', czyli jednym #)

• dokonać następujących zmian w dokumentacji

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

Innymi słowy:

• Zmień wartość @name
• Dodaj alias o nazwie kmmisc

---

Są to jedyne różnice między swoim przykładem i własnej dokumentacji pakietu.