Roxygenを使用したセッター関数の文書化

Question

私はユニークな広告以外に何もしない関数を持っています attr 任意のRオブジェクトに。ベースデモ：

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

これは、適切なRDファイルを生成することを除いて、魅力のように機能します。関連部分：

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

そしてもちろん、実行中に警告をトリガーします R CMD check 本来あるべきだ foo(var) <- value.

ヒントは本当に感謝されています！

---

アップデート: ：ありがとう Richierocks あるようです 修理

Answer 1

Roxygenタグを使用できます @usage

これが私のパッケージの1つの例です。

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

---

これにより、私の希望のドキュメントが得られます。

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value