ys_get_short: Get short

View source: R/ys-get.R

ys_get_shortR Documentation

Get short

Description

Forms a short for a column (ycol method) or columns (yspec method). Use purrr::map or purrr::map_chr to simply extract the short field.

Usage

ys_get_short(x, short_max = Inf, title_case = FALSE, ...)

Arguments

x

ycol or yspec object

short_max

if short is found, but contains more than short_max characters, col will be used

title_case

short will be converted with tools::toTitleCase if it is found

...

passed to short methods; see details

See Also

ys_get_unit, ys_get_label, ys_get_short_unit

Examples

spec <- ys_help$spec()

ys_get_short(spec)

ys_get_short(spec$WT)

## Not run: 
purrr:::map(spec,"short")

## End(Not run)

metrumresearchgroup/yspec documentation built on May 24, 2024, 12:48 a.m.