explicit_guide.yamlet {yamlet} | R Documentation |
Coerce Yamlet Guide to Something More Explicit
Description
Coerces yamlet 'guide' keys to something more explicit. The key '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 'yamlet'
explicit_guide(
x,
...,
test = getOption("yamlet_infer_guide", yamlet::infer_guide),
expand = getOption("yamlet_expand_codelist", TRUE),
data = NULL
)
Arguments
x |
yamlet |
... |
passed to |
test |
function or function name; supply non-default or globally set |
expand |
whether to expand empty guide list using sorted unique values. NA likely excluded. |
data |
optional data.frame for testing guides with length > 1 |
Details
If data
is supplied, guides that are lists
are checked to see if they evaluate to conditions in data context
(see isConditional.list
).
If so, inferences are based on the first guide element rather
than the guide as a whole.
This method iterates across the guide elements, renaming them
as specified by the value of test
. (default: infer_guide
).
test
should be a function (or name of one) that accepts x, data, and dots.
If a data.frame is passed to explicit_guide(), the relevant column will
be passed as data to test
.
Value
yamlet
See Also
Other explicit_guide:
explicit_guide()
,
explicit_guide.data.frame()
,
explicit_guide.dvec()
,
implicit_guide()
,
implicit_guide.data.frame()
,
implicit_guide.dvec()
,
infer_guide()
Examples
library(magrittr)
'CONC: [ concentration, µg/mL ]' %>% as_yamlet %>% explicit_guide
'RACE: [ subject race, [ Caucasian: 0, Latin: 1, Black: 2 ]]' %>% as_yamlet %>% explicit_guide
'RACE: [ subject race, [ Caucasian, Latin, Black ]]' %>% as_yamlet %>% explicit_guide
'RACE: [ subject race, //0/Caucasian//1/Latin//2/Black// ]' %>% as_yamlet %>% explicit_guide
'DATE: [ date, "%Y-%m-%d" ]' %>% as_yamlet %>% explicit_guide
'PRSE: [ standard error, "%" ]' %>% as_yamlet %>% explicit_guide