yamlet (version 1.2.1)

explicit_guide.data.frame: Coerce Data Frame Guide to Something More Explicit

Description

Coerces data.frame 'guide' attributes 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 data.frame
explicit_guide(
  x,
  ...,
  overwrite = getOption("yamlet_explicit_guide_overwrite", TRUE),
  simplify = getOption("yamlet_explicit_guide_simplify", TRUE),
  expand = getOption("yamlet_expand_codelist", TRUE)
)

Value

data.frame

Arguments

x

data.frame

...

named arguments passed to as_yamlet, explicit_guide, and decorate; un-named arguments limit scope

overwrite

passed as TRUE

simplify

whether to remove guide attribute

expand

whether to expand empty guide list using sorted unique values. NA likely excluded.

Details

This method pulls the 'decorations' off of the data.frame, converts to yamlet, applies explicit_guide.yamlet, purges 'guide' attributes from the data.frame, and then re-decorates using overwrite = TRUE.

See Also

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

Other dvec: [.dvec(), [<-.dvec(), [[.dvec(), [[<-.dvec(), as.data.frame.dvec(), as_dvec(), as_dvec.character(), as_dvec.complex(), as_dvec.dvec(), as_dvec.integer(), as_dvec.logical(), as_dvec.numeric(), c.dvec(), classified.dvec(), desolve.dvec(), format.dvec(), implicit_guide.dvec(), length.dvec(), print.dvec(), resolve.classified(), resolve.dvec(), unclassified.dvec()

Examples

library(magrittr)
x <- data.frame(
 ID = 1,
 CONC = 1,
 RACE = 1,
 SEX = 1,
 DATE = 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