roxygen2 "Lỗi: kiểm tra lại giá trị"

Question

Tôi nhận được lỗi từ roxygenize() mà tôi không thể hiểu được. Tôi có một gói các chức năng linh tinh trong đó các tập tin .Rd được tạo ra thông qua roxygen.

Lỗi là Error: titlerequires a value, điều này gợi ý rằng không có thẻ @title. Tuy nhiên, có một thẻ @title trong tệp kmmisc-package.R, vì vậy tôi không chắc chắn vấn đề là gì.

kmmisc-package.R chứa:

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

Tôi đang sử dụng R 2.13.2 với roxygen2 2.1 chỉ cài đặt lại từ cran. Hoàn chỉnh sessionInfo() là trong ý chính tại https://gist.github.com/1268056

Sửa

Theo gợi ý của @ Andrie của, bây giờ tôi có

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

mà vẫn tạo ra các lỗi tương tự.

Answer 1

Tôi không thể sao chép biểu mẫu lỗi mã đầu tiên của bạn ... Bạn có nhận được thông báo lỗi giống nhau từ roxygenize() đến ví dụ đơn giản sau không?

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

---

Một thông tin bổ sung:

Mã bởi @Andrie, #' @aliases kmmisc package-kmmisc, có @aliases problem. Trong roxygen2 2.1, #' @aliases a-b, có dấu gạch nối, tạo thẻ được trích dẫn Rd \alias{"a-b"}. Trong trường hợp này mã không có vấn đề, nhưng trong trường hợp khác đòi hỏi một số sự chú ý. Tất nhiên, nếu bạn cần thẻ được trích dẫn, bạn thêm #' @aliases a-b.

Vì vậy, tôi nghĩ rằng nó tốt hơn để thay thế #' @aliases kmmisc package-kmmisc với #' @aliases kmmisc trong trường hợp này:

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

Hãy thử như sau:

• Bỏ ghi chú báo cáo roxygen của bạn. (Điều này có thể là một vật phẩm SO, nhưng mỗi dòng roxygen nên bắt đầu với # ', tức là một đơn #)

• Tận dụng những thay đổi sau đây để các tài liệu

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

Nói cách khác:

• Thay đổi giá trị @name
• Thêm bí danh được gọi là kmmisc

---

Đây là sự khác biệt duy nhất giữa ví dụ của bạn và tài liệu gói của riêng tôi.