explicit_guide.dvec: Coerce Decorated Vector Guide to Something More Explicit

In yamlet: Versatile Curation of Table Metadata

Coerce Decorated Vector Guide to Something More Explicit

Description

Coerces dvec 'guide' attribute to something more explicit. The attribute 'guide' generally suggests a guide to interpretation of a data item, such as units, formats, codelists, and encodings. The idea here is to replace 'guide' with something explicit in case required downstream.

Usage

## S3 method for class 'dvec'
explicit_guide(
  x,
  ...,
  overwrite = getOption("yamlet_explicit_guide_overwrite", TRUE),
  simplify = getOption("yamlet_explicit_guide_simplify", TRUE),
  expand = getOption("yamlet_expand_codelist", TRUE)
)

Arguments

x	dvec
...	named arguments passed to as_yamlet, explicit_guide, and decorate; un-named arguments ignored
overwrite	whether to overwrite attributes
simplify	whether to remove guide attribute
expand	whether to expand empty guide list using sorted unique values. NA likely excluded.

Value

dvec

See Also

Other explicit_guide: explicit_guide(), explicit_guide.data.frame(), explicit_guide.yamlet(), implicit_guide(), implicit_guide.data.frame(), implicit_guide.dvec(), infer_guide()

Examples

library(magrittr)
x <- data.frame(
 ID = as_dvec(1),
 CONC = as_dvec(1),
 RACE = as_dvec(1),
 SEX = as_dvec(1),
 DATE = as_dvec(1)
)
x %<>% modify(ID, label = 'subject identifier')
x %<>% modify(CONC, label = 'concentration', guide = 'ng/mL')
x %<>% modify(RACE, label = 'race', guide = list(white = 0, black = 1, asian = 2))
x %<>% modify(SEX, label = 'sex', guide = list(female = 0, male = 1))
x %<>% modify(DATE, label  = 'date', guide = '%Y-%m-%d')
x %>% decorations
x %>% explicit_guide %>% decorations
x %>% explicit_guide(DATE) %>% decorations # limit scope
x %$% DATE %>% explicit_guide

yamlet documentation built on June 8, 2025, 1:57 p.m.