Skip to contents

Get predefined @description label

Source: R/pkgsnip.gen.R
description_lbl.Rd

Returns a predefined label intended to be used as a function's description using roxygen2's @description tag. Shorthand for roxy_lbl(type = "description").

Usage

description_lbl(id = roxy_lbls(type = "description")$id, ...)

Arguments

id

Label identifier. See roxy_lbls() for possible values.

...

Further named arguments passed on to roxy_lbl().

Value

A glue character scalar.

Details

A label can be inserted using inline R code as follows:

#' @description `r pkgsnip::description_lbl("ID")`

Note that the above only works in roxygen2 7.1.0+.

Currently, the following @description labels are available:

idarguments
cli_markup_support
date
dates
datetime
datetimes
dbi_connection
df_or_tibble
dm
dyn_dots_support
end_date
eol
funky_configpkg
ggplot2_obj
glue_chr
gt_obj
http_methodone_of
max_cache_age
max_tries
num_vrsn
opt_global_max_cache_agepkg, global_max_cache_age
path
paths
pkg
plotly_obj
quiet
r_obj
resp_obj
show_progress
start_date
strict_list
sym
tbl_data
tibble
tibble_colscols
tibble_customcustom
tidy_select_support
use_cache

Note that the pkg argument defaults to the name of the package from which this function is called (NULL if not run within a package environment).

See also

roxygen2 label functions data_roxy_lbls, data_types, param_lbl(), return_lbl(), roxy_lbl(), roxy_lbls(), title_lbl(), type()

Examples

pkgsnip::description_lbl(id = "dyn_dots_support")
#> [Dynamic dots][rlang::dyn-dots] are supported.

# some labels take additional arguments
pkgsnip::description_lbl(id = "opt_global_max_cache_age",
                         global_max_cache_age = "6h",
                         pkg = "foo")
#> Note that [on package load][base::ns-hooks], the cache will be cleared from entries exceeding a global maximum timespan set by the \R [option][base::options()] `foo.global_max_cache_age` (defaults to `6h` if unset).

# note that the `pkg` argument always defaults to the current package
# (none if run from the global environment)
pkgsnip::description_lbl(id = "opt_global_max_cache_age",
                         global_max_cache_age = "6h")
#> Note that [on package load][base::ns-hooks], the cache will be cleared from entries exceeding a global maximum timespan set by the \R [option][base::options()] `pkgsnip.global_max_cache_age` (defaults to `6h` if unset).