Документирование функций setter с roxygen

Question

У меня есть функция, которая делает не что иное, как объявление уникальным attr любому объекту R. База демо:

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

Это работает как шарм для создания хорошего файла Rd кроме, соответствующая часть:

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

И, конечно, это вызывает предупреждение при запуске R CMD check, как это должно быть foo(var) <- value.

Любые подсказки были бы в восторге!

---

Update: благодаря richierocks, кажется, есть fix

Answer 1

Вы можете использовать roxygen тег @usage

Вот пример одного из моих пакетов:

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

---

Это приводит к моей желаемой документации:

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value