r - roxygenを使用したセッター機能の文書化

Question

attrRオブジェクトに固有の広告を出すだけの機能があります。基本デモ：

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