Documentando funciones del setter con roxygen

Question

Tengo una función que no hace más que anuncios un único attr a cualquier objeto R. demostración de base:

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

Esto funciona como un encanto, excepto para generar un buen archivo Rd, parte pertinente:

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

Y, por supuesto, se desencadena una advertencia mientras se ejecuta R CMD check como debe ser foo(var) <- value.

¡Cualquier pista sería muy apreciada!

---

actualización: gracias a richierocks parece que hay un fix

Answer 1

Puede utilizar la etiqueta roxygen @usage

Este es un ejemplo de uno de mis paquetes:

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

---

Esto da como resultado la documentación deseada:

Usage 

    pattern(x) <- value 

Arguments 
x surveydata object 

value New value