roxygen2

roksigen2

Premis roxygen2 sederhana: jelaskan fungsi Anda dalam komentar di samping definisinya dan roxygen2 akan memproses kode sumber dan komentar Anda untuk secara otomatis menghasilkan file .Rd di man/ , NAMESPACE , dan, jika diperlukan, bidang Collate di DESCRIPTION .

Instalasi

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

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

Penggunaan

Premis roxygen2 sederhana: jelaskan fungsi Anda dalam komentar di samping definisinya dan roxygen2 akan memproses kode sumber dan komentar Anda untuk menghasilkan file Rd di direktori man/ . Berikut ini contoh sederhana dari paket 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 ) {
}

Saat Anda roxygenise() (atau devtools::document() ) paket Anda, komentar ini akan secara otomatis diubah menjadi .Rd yang digunakan R untuk menghasilkan dokumentasi yang Anda lihat saat Anda mengetik ?str_length .

Pelajari lebih lanjut

Untuk memulai, baca dulu vignette("roxygen2") . Kemudian baca lebih lanjut tentang komponen paket spesifik yang ingin Anda buat:

• Mulailah dengan vignette("rd") untuk mempelajari cara mendokumentasikan fungsi Anda dengan roxygen2.

• vignette("rd-other") membahas cara mendokumentasikan hal-hal lain seperti kumpulan data, paket itu sendiri, dan berbagai bagian yang digunakan oleh sistem OOP R.

• vignette("rd-formatting") memberikan detail dukungan rmarkdown roxygen2.

• vignette("reuse") mendemonstrasikan alat yang tersedia untuk menggunakan kembali dokumentasi di banyak tempat.

• vignette("namespace") menjelaskan cara membuat file NAMESPACE , cara kerja penspasian nama di R, dan cara menggunakan roxygen2 untuk lebih spesifik tentang kebutuhan dan persediaan paket Anda.

• Untuk bidang Collate di DESCRIPTION , lihat ?update_collate() .