Documentare le funzioni del setter con Roxygen

Question

Ho una funzione che non fa altro che annunci un unico attr a qualsiasi oggetto R. Base Demo:

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

Funziona come un incantesimo tranne per la generazione di un buon file RD, parte pertinente:

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

E ovviamente innesca un avvertimento durante la corsa R CMD check come dovrebbe essere foo(var) <- value.

Qualsiasi suggerimento sarebbe davvero apprezzato!

---

Aggiornare: grazie a Richirocks Sembra che ci sia un aggiustare

Answer 1

Puoi usare il tag roxygen @usage

Ecco un esempio di uno dei miei pacchetti:

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

---

Ciò si traduce nella documentazione desiderata:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value