最初の R パッケージを作成しようとしています。Google で検索しましたが、私の質問に固有のものは何も出てきませんでした。
roxygenのマニュアルには、
@family ファミリ名 ファミリ内のすべての関数間の相互参照を自動的に追加します。関数は複数のファミリに属することができます。
所属する関数ファミリにアクセスするにはどうすればよいですか? 追加した後のドキュメントには@family text
何も表示されません...
Hadley の本から、@family
複数形にする必要があります。
関連する関数のファミリがあり、すべての関数がファミリ内の他のすべての関数にリンクする必要がある場合は、@family を使用します。@family の値は複数形にする必要があります。
代わりに、たとえば @family text
表示する必要がある場合があります。@family some text
また、同じ@family
タグを複数の関数に追加する必要があります。たとえば、devtools
パッケージにはいくつかの機能が?devtools::dev-example
あり?devtools::run-examples
、タグがあります
#' @family example functions
参照セクションには相互のリンクがあります