Documenting setter functions with roxygen

Question

I have a function that does nothing more than ads a unique attr to any R object. Base demo:

#\' Setter function
#\' @param x an R object
#\' @pa         


        

Answer 1

You can use the roxygen tag @usage

Here is an example from one of my 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
}

---

This results in my desired documentation:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value