Chức năng đặt tài liệu với roxygen

Question

Tôi có chức năng không có gì khác ngoài quảng cáo attr duy nhất cho bất kỳ đối tượng R nào. Cơ sở giới thiệu:

#' Setter function 
#' @param x an R object 
#' @param value a character value to set 
#' @export 
`foo<-` <- function(x, value){ 
    attr(x, 'foo') <- value 
    return(x) 
} 

này hoạt động như một nét duyên dáng, ngoại trừ để tạo ra một tập tin Rd tốt, một phần có liên quan:

\usage{ 
    foo(var, value) <- value 
} 

Và tất nhiên nó gây nên một cảnh báo khi chạy R CMD check như nó phải được foo(var) <- value.

Mọi gợi ý sẽ thực sự được đánh giá cao!

---

Cập nhật: nhờ richierocks có vẻ như có một fix

Answer 1

Bạn có thể sử dụng thẻ roxygen @usage

Dưới đây là một ví dụ từ một trong các gói của tôi:

#' @rdname pattern 
#' @usage pattern(x) <- value 
#' @param value New value 
#' @export pattern<- 
"pattern<-" <- function(x, value=c("^", "($|(_\\d+(_\\d+)*)$)")){ 
    attr(x, "pattern") <- value 
    x 
} 

---

Kết quả này trong tài liệu mong muốn của tôi:

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value