rd_roclet: Roclet: make Rd files.

Description Usage See Also Examples

View source: R/rd.R

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

1

See Also

Other roclets: namespace_roclet(), vignette_roclet()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#' 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) {
}

Example output



roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.