r - 関数クロージャの文書化

Question

たとえば、パッケージに関数クロージャがあるとします。

f = function(x) {
    x = x
    g = function(y) x <<- y
    h = function() x
    list(g = g, h = h)
}

l = f(5)
l$g(10)
l$h()

この関数を文書化する正しい（公式のCRANの意味での）方法は何ですか？特に、

1. 使いたいroxygen2
2. 機能のドキュメントを提供したいと思いgますh

Answer 1

?family1つの方法は、文書化する場所g()やファイルh()のValueセクションで同様のことを行うことです。次に、2つの機能のセクションエントリでポイントする、特注の.Rd拡張ドキュメントを提供g()します。h()\section{foo}Value

\value{
  Returns an object of class \code{"foo"}, a list with the
  following components:

  \item{g}{function; does foo. See Returned Functions for details.}
  \item{h}{function; does bar. See Returned Functions for details.}
}
\section{Returned Functions}{
  The returned functions do, blah blah...

  \code{g} is defined as

  \preformatted{
  g(x, y, z, ...)
  }

  Arguments are:

  \describe{
    \item{x}{foo}
    \item{y}{foo}
    \item{z}{foo}
  }
}

roxygenは引数からこれを行うことはできませんが@param、Rdファイルに追加する任意のroxygenセクションとしてこれを書き込むことができるはずです。このValueセクションは、標準の酸素マークアップとして記述できます。文字通り入力する必要があるのは、特注のセクションのみです。