roxygen2

ロキシゲン2

roxygen2 の前提は単純です。定義の横にコメントで関数を記述すると、 roxygen2 がソース コードとコメントを処理して、 man/ 、 NAMESPACE 、および必要に応じてDESCRIPTIONのCollate ​​e フィールドに.Rdファイルを自動的に生成します。

インストール

 # Install roxygen2 from CRAN
install.packages( " roxygen2 " )

# Or the development version from GitHub:
# install.packages("pak")
pak :: pak( " r-lib/roxygen2 " )

使用法

roxygen2 の前提は単純です。定義の横にコメントで関数を記述すると、roxygen2 がソース コードとコメントを処理してman/ディレクトリに Rd ファイルを生成します。 stringr パッケージの簡単な例を次に示します。

 # ' The length of a string
# '
# ' Technically this returns the number of "code points", in a string. One
# ' code point usually corresponds to one character, but not always. For example,
# ' an u with a umlaut might be represented as a single character or as the
# ' combination a u and an umlaut.
# '
# ' @inheritParams str_detect
# ' @return A numeric vector giving number of characters (code points) in each
# '    element of the character vector. Missing string have missing length.
# ' @seealso [stringi::stri_length()] which this function wraps.
# ' @export
# ' @examples
# ' str_length(letters)
# ' str_length(NA)
# ' str_length(factor("abc"))
# ' str_length(c("i", "like", "programming", NA))
str_length <- function ( string ) {
}

roxygenise() (またはdevtools::document() ) すると、パッケージのこれらのコメントは、 ?str_lengthと入力したときに表示されるドキュメントを生成するために R が使用する.Rdに自動的に変換されます。

もっと詳しく知る

始めるには、まずvignette("roxygen2")読んでください。次に、生成する特定のパッケージ コンポーネントについて詳しく読んでください。

• vignette("rd")から始めて、roxygen2 を使用して関数を文書化する方法を学びます。

• vignette("rd-other")データセット、パッケージ自体、R の OOP システムで使用されるさまざまな部分など、他のものを文書化する方法について説明します。

• vignette("rd-formatting") roxygen2 の rmarkdown サポートの詳細を示します。

• vignette("reuse")ドキュメントを複数の場所で再利用するために使用できるツールを示します。

• vignette("namespace") NAMESPACEファイルの生成方法、R での名前空間の仕組み、roxygen2 を使用してパッケージが必要とするものと提供するものを特定する方法について説明します。

• DESCRIPTIONのCollateフィールドについては、 ?update_collate()を参照してください。