Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

rd_roclet

Roclet: make Rd files.


Description

This roclet is the workhorse of roxygen, producing the .Rd files that R uses to document that functions, datasets, packages, classes, and other objects.

See vignette("rd") for details.

Generally you will not call this function directly but will instead use roxygenise() specifying the rd roclet

Usage

rd_roclet()

See Also

Other roclets: namespace_roclet(), vignette_roclet()

Examples

#' The length of a string (in characters)
#'
#' @param x String input character vector
#' @return An integer vector the same length as `x`.
#'   `NA` strings have `NA` length.
#' @seealso [nchar()]
#' @export
#' @examples
#' str_length(letters)
#' str_length(c("i", "like", "programming", NA))
str_length <- function(x) {
}

roxygen2

In-Line Documentation for R

v7.1.1
GPL (>= 2)
Authors
Hadley Wickham [aut, cre, cph] (<https://orcid.org/0000-0003-4757-117X>), Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.