Documentar las funciones de Setter con Roxygen

Question

Tengo una función que no hace nada más que anuncios de 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 relevante:

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

Y, por supuesto, desencadena una advertencia mientras corre R CMD check como debería ser foo(var) <- value.

¡Cualquier pista sería realmente apreciada!

---

Actualizar: gracias a Richierocks parece que hay un arreglar

Answer 1

Puedes usar la etiqueta Roxygen @usage

Aquí hay 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 mi documentación deseada:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value