Dokumentowanie funkcji ustawiających z roxygenem

Question

Mam funkcję, która nie robi niczego więcej niż reklamuje unikalny obiekt attr dla dowolnego obiektu R. demo podstawa:

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

To działa jak czar z wyjątkiem generowania dobry plik Rd, odpowiednia część:

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

I oczywiście wywołuje ostrzeżenie podczas pracy R CMD check jak powinno być foo(var) <- value.

Wszelkie wskazówki są naprawdę doceniane!

---

Aktualizacja: dzięki richierocks wydaje się, że jest fix

Answer 1

Można użyć tagu roxygen @usage

Oto przykład jednego z moich pakietów:

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

---

Powoduje to uzyskanie wymaganej dokumentacji:

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value