Documenter les fonctions de setter avec Roxygen

Question

J'ai une fonction qui ne fait rien de plus que les publicités attr à n'importe quel objet r. Démo 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)
}

Cela fonctionne comme un charme, sauf pour générer un bon fichier RD, partie pertinente:

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

Et bien sûr, cela déclenche un avertissement pendant la course R CMD check comme cela devrait être foo(var) <- value.

Tout indice serait vraiment apprécié!

---

Mise à jour: grâce à riches il semble qu'il y ait un réparer

Answer 1

Vous pouvez utiliser la balise Roxygen @usage

Voici un exemple de l'un de mes packages:

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

---

Cela se traduit par la documentation souhaitée:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value