roxygen2

roxygen2

A premissa do roxygen2 é simples: descreva suas funções nos comentários ao lado de suas definições e o roxygen2 processará seu código-fonte e comentários para gerar automaticamente arquivos .Rd em man/ , NAMESPACE e, se necessário, o campo Collate em DESCRIPTION .

Instalação

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

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

Uso

A premissa do roxygen2 é simples: descreva suas funções nos comentários ao lado de suas definições e o roxygen2 processará seu código-fonte e comentários para produzir arquivos Rd no diretório man/ . Aqui está um exemplo simples do pacote 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 ) {
}

Quando você roxygenise() (ou devtools::document() ) seu pacote, esses comentários serão automaticamente transformados no .Rd que R usa para gerar a documentação que você vê ao digitar ?str_length .

Saber mais

Para começar, primeiro leia vignette("roxygen2") . Em seguida, leia mais sobre o componente específico do pacote que você deseja gerar:

• Comece com vignette("rd") para aprender como documentar suas funções com o roxygen2.

• vignette("rd-other") discute como documentar outras coisas, como conjuntos de dados, o pacote em si e as várias peças usadas pelos sistemas OOP do R.

• vignette("rd-formatting") fornece detalhes do suporte ao rmarkdown do roxygen2.

• vignette("reuse") demonstra as ferramentas disponíveis para reutilizar documentação em vários locais.

• vignette("namespace") descreve como gerar um arquivo NAMESPACE , como o namespace funciona em R e como você pode usar o roxygen2 para ser específico sobre o que seu pacote precisa e fornece.

• Para o campo Collate em DESCRIPTION , consulte ?update_collate() .